Clean up READMEs

README.md

@@ -1,36 +1,38 @@
-# Oh My Zsh
+Oh My Zsh
+=========
 
-OMZ is a configuration framework for [Zsh](http://www.zsh.org) that enriches
+OMZ is a configuration framework for [Zsh][1] that enriches the command line
-the command line interface environment with sane defaults, aliases, functions,
+interface environment with sane defaults, aliases, functions, auto completion,
-auto completion, and prompt themes.
+and prompt themes.
 
-## Installation
+Installation
+------------
 
 Oh My Zsh will work with any recent release of Zsh, but the minimum recommended
 version is 4.3.10.
 
-1. Clone the repository:
+   1. Clone the repository:
 
-    `git clone https://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh`
+      `git clone https://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh`
 
-2. Initialize the submodules:
+   2. Initialize the submodules:
 
-    `cd ~/.oh-my-zsh && git submodule update --init --recursive`
+      `cd ~/.oh-my-zsh && git submodule update --init --recursive`
 
-3. Create a new Zsh configuration by copying the Zsh template provided:
+   3. Create a new Zsh configuration by copying the Zsh template provided:
 
-    `cp ~/.oh-my-zsh/templates/zshrc ~/.zshrc`
+      `cp ~/.oh-my-zsh/templates/zshrc ~/.zshrc`
 
-4. Set Zsh as your default shell:
+   4. Set Zsh as your default shell:
 
-    `chsh -s /bin/zsh`
+      `chsh -s /bin/zsh`
 
-5. Open a new Zsh terminal window or tab.
+   5. Open a new Zsh terminal window or tab.
 
 ### Mac OS X
 
-If you have administrator privileges, you must fix an Apple misconfiguration
+If you have administrator privileges, you must fix an Apple misconfiguration in
-in Mac OS X 10.7 Lion by renaming `/etc/zshenv` to `/etc/zprofile`, or Zsh will
+Mac OS X 10.7 Lion by renaming `/etc/zshenv` to `/etc/zprofile`, or Zsh will
 have the wrong `PATH` when executed non-interactively by scripts.
 
 ### Troubleshooting
@@ -46,41 +48,36 @@ accompanying README files to learn of what is available.
 
 ### Modules
 
-1. Browse `modules/` to see what is available.
+   1. Browse `modules/` to see what is available.
-2. Load the modules you need in `~/.zshrc` then open a new Zsh terminal window
+   2. Load the modules you need in `~/.zshrc` then open a new Zsh terminal
-   or tab.
+      window or tab.
 
 ### Themes
 
-1. For a list of themes, type `prompt -l`.
+   1. For a list of themes, type `prompt -l`.
-2. To preview a theme, type `prompt -p name`.
+   2. To preview a theme, type `prompt -p name`.
-3. Load the theme you like in `~/.zshrc` then open a new Zsh terminal window or
+   3. Load the theme you like in `~/.zshrc` then open a new Zsh terminal window
-   tab.
+      or tab.
-   ![sorin theme](http://i.imgur.com/aipDQ.png "sorin theme")
+      ![sorin theme][2]
 
 ## Customization
 
-The project is managed via [Git](http://git-scm.com). It is highly recommend
+The project is managed via [Git][3]. It is highly recommend that you commit
-that you commit your changes and push them to [GitHub](http://github.com) to
+your changes and push them to [GitHub][4] to not lose them. If you do not know
-not lose them. If you do not know how to use Git, follow this
+how to use Git, follow this [tutorial][5] and bookmark this [reference][6].
-[tutorial](http://gitimmersion.com) and bookmark this
-[reference](http://gitref.org).
 
 ### Completions
 
-Submit program completions to the
+Submit program completions to the [zsh-completions][7] project. The Oh My Zsh
-[zsh-completions](https://github.com/zsh-users/zsh-completions) project. The Oh
+completions directory will be synched against it.
-My Zsh completions directory will be synched against it.
 
 ## Resources
 
-The [Zsh Reference Card](http://www.bash2zsh.com/zsh_refcard/refcard.pdf) is
+The [Zsh Reference Card][8] is indispensable.
-indispensable.
 
 ## Contribute
 
-This project would not exist without all of its users and
+This project would not exist without all of its users and [contributors][9].
-[contributors](https://github.com/sorin-ionescu/oh-my-zsh/contributors).
 
 If you have ideas on how to make the configuration easier to maintain or
 improve its performance, do not hesitate to fork and send pull requests.
@@ -109,3 +106,13 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
+[1]: http://www.zsh.org
+[2]: http://i.imgur.com/aipDQ.png "sorin theme"
+[3]: http://git-scm.com
+[4]: https://github.com
+[5]: http://gitimmersion.com
+[6]: http://gitref.org
+[7]: https://github.com/zsh-users/zsh-completions
+[8]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
+[9]: https://github.com/sorin-ionescu/oh-my-zsh/contributors
+

modules/command-not-found/README.md

@@ -1,4 +1,4 @@
-command-not-found
+Command-Not-Found
 =================
 
 Loads the [command-not-found][1] tool on Debian-based distributions.
@@ -6,9 +6,10 @@ Loads the [command-not-found][1] tool on Debian-based distributions.
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][2].*
 
- - [Joseph Booker](/sargas)
+  - [Joseph Booker](https://github.com/sargas)
 
 [1]: https://code.launchpad.net/command-not-found
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/completion/README.md

@@ -16,9 +16,10 @@ This module must be loaded **after** the *alias* module but **before** the
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][2].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
 
-[1]: /zsh-users/zsh-completions
+[1]: https://github.com/zsh-users/zsh-completions
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/directory/README.md

@@ -6,29 +6,31 @@ Sets directory options and defines directory aliases.
 Options
 -------
 
- - `AUTO_CD` auto cd to a directory without typing `cd`.
+  - `AUTO_CD` auto cd to a directory without typing `cd`.
- - `AUTO_PUSHD` push the old directory onto the stack on `cd`.
+  - `AUTO_PUSHD` push the old directory onto the stack on `cd`.
- - `PUSHD_IGNORE_DUPS` don't store duplicates in the stack.
+  - `PUSHD_IGNORE_DUPS` don't store duplicates in the stack.
- - `PUSHD_SILENT` do not print the directory stack after `pushd` or `popd`.
+  - `PUSHD_SILENT` do not print the directory stack after `pushd` or `popd`.
- - `PUSHD_TO_HOME` push to home directory when no argument is given.
+  - `PUSHD_TO_HOME` push to home directory when no argument is given.
- - `CDABLE_VARS` change directory to a path stored in a variable.
+  - `CDABLE_VARS` change directory to a path stored in a variable.
- - `AUTO_NAME_DIRS` auto add variable-stored paths to `~` list.
+  - `AUTO_NAME_DIRS` auto add variable-stored paths to `~` list.
- - `MULTIOS` write to multiple descriptors.
+  - `MULTIOS` write to multiple descriptors.
- - `EXTENDED_GLOB` use extended globbing syntax.
+  - `EXTENDED_GLOB` use extended globbing syntax.
- - `CLOBBER` don't overwrite existing files with `>` and `>>`. Use `>!` and
+  - `CLOBBER` don't overwrite existing files with `>` and `>>`. Use `>!` and
     `>>!` to bypass.
 
 Aliases
 -------
 
- - `d` print the contents of the directory stack.
+  - `d` print the contents of the directory stack.
- - `1 ... 9` change directory to the **n** previous one.
+  - `1 ... 9` change directory to the **n** previous one.
 
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][1].*
 
- - [James Cox](/imajes)
+  - [James Cox](https://github.com/imajes)
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/gnu-utility/README.md

@@ -1,4 +1,4 @@
-gnu-utility
+GNU Utility
 ===========
 
 Provides for the interactive use of GNU utilities on non-GNU systems.
@@ -25,7 +25,9 @@ the desired prefix:
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][1].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/haskell/README.md

@@ -20,9 +20,10 @@ Install packages into per user directories with `cabal install --user`.
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][2].*
 
- - [Sebastian Wiesner](/lunaryorn)
+  - [Sebastian Wiesner](https://github.com/lunaryorn)
 
 [1]: http://www.haskell.org/cabal/
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/history-substring-search/README.md

@@ -27,10 +27,11 @@ To enable highlighting for this module only, and the following line to *zshrc*:
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][2].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
- - [Suraj N. Kurapati](/sunaku)
+  - [Suraj N. Kurapati](https://github.com/sunaku)
 
 [1]: http://fishshell.com
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/history/README.md

@@ -6,39 +6,40 @@ Sets [history][1] options and defines history aliases.
 VARIABLES
 ---------
 
- - `HISTFILE` the file to save the history in when an interactive shell exits.
+  - `HISTFILE` the file to save the history in when an interactive shell exits.
- - `HISTSIZE` the maximum size of the history list.
+  - `HISTSIZE` the maximum size of the history list.
- - `SAVEHIST` the maximum number of history events to save in the history file.
+  - `SAVEHIST` the maximum number of history events to save in the history file.
 
 Options
 -------
 
- - `BANG_HIST` treat the **!** character specially during expansion.
+  - `BANG_HIST` treat the **!** character specially during expansion.
- - `EXTENDED_HISTORY` write the history file in the *:start:elapsed;command* format.
+  - `EXTENDED_HISTORY` write the history file in the *:start:elapsed;command* format.
- - `INC_APPEND_HISTORY` write to the history file immediately, not when the shell exits.
+  - `INC_APPEND_HISTORY` write to the history file immediately, not when the shell exits.
- - `SHARE_HISTORY` share history between all sessions.
+  - `SHARE_HISTORY` share history between all sessions.
- - `HIST_EXPIRE_DUPS_FIRST` expire duplicate entries first when trimming history.
+  - `HIST_EXPIRE_DUPS_FIRST` expire duplicate entries first when trimming history.
- - `HIST_IGNORE_DUPS` do not record an entry that was just recorded again.
+  - `HIST_IGNORE_DUPS` do not record an entry that was just recorded again.
- - `HIST_IGNORE_ALL_DUPS` delete old recorded entry if new entry is a duplicate.
+  - `HIST_IGNORE_ALL_DUPS` delete old recorded entry if new entry is a duplicate.
- - `HIST_FIND_NO_DUPS` do not display a line previously found.
+  - `HIST_FIND_NO_DUPS` do not display a line previously found.
- - `HIST_IGNORE_SPACE` do not record an entry starting with a space.
+  - `HIST_IGNORE_SPACE` do not record an entry starting with a space.
- - `HIST_SAVE_NO_DUPS` do not write duplicate entries in the history file.
+  - `HIST_SAVE_NO_DUPS` do not write duplicate entries in the history file.
- - `HIST_REDUCE_BLANKS` remove superfluous blanks before recording entry.
+  - `HIST_REDUCE_BLANKS` remove superfluous blanks before recording entry.
- - `HIST_VERIFY` do not execute immediately upon history expansion.
+  - `HIST_VERIFY` do not execute immediately upon history expansion.
- - `HIST_BEEP` beep when accessing non-existent history.
+  - `HIST_BEEP` beep when accessing non-existent history.
 
 Aliases
 -------
 
- - `history-stat` list the ten most used commands
+  - `history-stat` list the ten most used commands
 
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][2].*
 
- - [Robby Russell](/robbyrussell)
+  - [Robby Russell](https://github.com/robbyrussell)
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
 
 [1]: http://zsh.sourceforge.net/Guide/zshguide02.html#l16
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/osx/README.md

@@ -1,14 +1,15 @@
 OSX
 ===
+
 Defines [Mac OS X][1] aliases and functions.
 
 Aliases
 -------
-   change to the current _Finder_ directory.
+
- - `cdf` change the current working director to the current _Finder_ directory.
+  - `cdf` change the current working director to the current _Finder_ directory.
- - `pushdf` push the current working directory onto the directory queue and
+  - `pushdf` push the current working directory onto the directory queue and
- - `ql` quick look at files.
+  - `ql` quick look at files.
- - `rm-osx-cruft` delete .DS\_Store, \_\_MACOSX cruft.
+  - `rm-osx-cruft` delete .DS\_Store, \_\_MACOSX cruft.
 
 Functions
 ---------
@@ -22,11 +23,12 @@ Functions
 
 Authors
 -------
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][4].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
 
 [1]: http://www.apple.com/macosx/
 [2]: http://bruji.com/bwana/
 [3]: http://www.iterm2.com/
+[4]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/prompt/README.md

@@ -6,18 +6,19 @@ Loads prompt [themes][1].
 Settings
 --------
 
-To select a prompt theme, add the following to *zshrc*, and replace **name** with the
+To select a prompt theme, add the following to *zshrc*, and replace **name**
-name of the theme you wish to load. Setting it to **random** will load a random
+with the name of the theme you wish to load. Setting it to **random** will load
-theme.
+a random theme.
 
     zstyle ':omz:module:prompt' theme 'name'
 
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][2].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
 
 [1]: http://zsh.sourceforge.net/Doc/Release/User-Contributions.html#Prompt-Themes
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/python/README.md

@@ -33,13 +33,14 @@ environments will be stored.
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][5].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
- - [Sebastian Wiesner](/lunaryorn)
+  - [Sebastian Wiesner](https://github.com/lunaryorn)
 
 [1]: http://www.python.org/dev/peps/pep-0370/
 [2]: http://www.doughellmann.com/projects/virtualenvwrapper/
 [3]: http://pypi.python.org/pypi/virtualenv
 [4]: http://www.doughellmann.com/docs/virtualenvwrapper/#introduction
+[5]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/screen/README.md

@@ -1,14 +1,14 @@
-screen
+GNU Screen
-======
+==========
 
 Defines [GNU Screen][1] aliases and provides for auto launching it at start-up.
 
 Aliases
 -------
 
- - `sl` list sessions/socket directory.
+  - `sl` list sessions/socket directory.
- - `sn` start a new session.
+  - `sn` start a new session.
- - `sr` attach to a session if one exists or start a new one.
+  - `sr` attach to a session if one exists or start a new one.
 
 Settings
 --------
@@ -24,9 +24,10 @@ To enable this feature, add the following line to *zshrc*:
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][2].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
 
 [1]: http://www.gnu.org/software/screen/
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/tmux/README.md

@@ -1,4 +1,4 @@
-tmux
+Tmux
 ====
 
 Defines [tmux][1] aliases and provides for auto launching it at start-up.
@@ -6,8 +6,8 @@ Defines [tmux][1] aliases and provides for auto launching it at start-up.
 Aliases
 -------
 
- - `ta` attach or switch to a tmux session.
+  - `ta` attach or switch to a tmux session.
- - `tl` list sessions managed by the tmux server.
+  - `tl` list sessions managed by the tmux server.
 
 Settings
 --------
@@ -35,7 +35,7 @@ connected** to be displayed, which can be fixed by installing
 [reattach-to-user-namespace][3], available in [Homebrew][4], and adding the
 following to *tmux.conf*:
 
-    set-option -g default-command "reattach-to-user-namespace -l $SHELL -l"
+   set-option -g default-command "reattach-to-user-namespace -l $SHELL -l"
 
 Furthermore, tmux is known to cause **kernel panics** on Mac OS X. A discussion
 about this and OMZ has already been opened [here][2].
@@ -43,13 +43,14 @@ about this and OMZ has already been opened [here][2].
 Authors
 -------
 
-*The authors of this module should be contacted via the github bug tracker.*
+*The authors of this module should be contacted via the [issue tracker][5].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
- - [Colin Hebert](/ColinHebert)
+  - [Colin Hebert](https://github.com/ColinHebert)
 
 [1]: http://tmux.sourceforge.net
 [2]: http://git.io/jkPqHg
 [3]: ChrisJohnsen/tmux-MacOSX-pasteboard
 [4]: mxcl/homebrew
+[5]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/utility/README.md

@@ -6,25 +6,27 @@ Defines additional utilities functions.
 Aliases
 -------
 
- - `http-serve` serves a directory via HTTP.
+  - `http-serve` serves a directory via HTTP.
- - `pmine` displays user owned processes status.
+  - `pmine` displays user owned processes status.
 
 Functions
 ---------
 
- - `mkdcd` makes a directory and changes to it.
+  - `mkdcd` makes a directory and changes to it.
- - `cdls` changes to a directory and lists its contents.
+  - `cdls` changes to a directory and lists its contents.
- - `pushdls` pushes an entry onto the directory stack and lists its contents.
+  - `pushdls` pushes an entry onto the directory stack and lists its contents.
- - `popdls` pops an entry off the directory stack and lists its contents.
+  - `popdls` pops an entry off the directory stack and lists its contents.
- - `slit` prints columns 1 2 3 ... n.
+  - `slit` prints columns 1 2 3 ... n.
- - `find-exec` finds files and executes a command on them.
+  - `find-exec` finds files and executes a command on them.
 
 Authors
 -------
 
-*The authors of this module should be contacted via the GitHub issue tracker.*
+*The authors of this module should be contacted via the [issue tracker][1].*
 
- - [Robby Russell](/robbyrussell)
+  - [Robby Russell](https://github.com/robbyrussell)
- - [Suraj N. Kurapati](/sunaku)
+  - [Suraj N. Kurapati](https://github.com/sunaku)
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/wakeonlan/README.md

@@ -1,5 +1,5 @@
-wakeonlan
+Wake-on-LAN
-=========
+===========
 
 This module provides a wrapper around the [wakeonlan][1] tool.
 
@@ -26,11 +26,12 @@ For more information on the configuration file format, read the
 Authors
 -------
 
-*The authors of this module should be contacted via Github issue tracker.*
+*The authors of this module should be contacted via [issue tracker][3].*
 
- - [Paul Dann](/giddie)
+  - [Paul Dann](https://github.com/giddie)
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
 
 [1]: http://gsd.di.uminho.pt/jpo/software/wakeonlan/
 [2]: http://man.cx/wakeonlan
+[3]: https://github.com/sorin-ionescu/oh-my-zsh/issues
 

modules/z/README.md

@@ -1,4 +1,4 @@
-z
+Z
 =
 
 Maintains a frequently used directory list for fast directory changes. For more
@@ -7,16 +7,17 @@ information see [z][1].
 Aliases
 -------
 
- - `z` cd to most frecent dir matching.
+  - `z` cd to most frecent dir matching.
- - `j` same as `z` for [autojump][2] converts.
+  - `j` same as `z` for [autojump][2] converts.
 
 Authors
 -------
 
-*The authors of this module should be contacted via the github bug tracker.*
+*The authors of this module should be contacted via the [issue tracker][3].*
 
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
 
 [1]: https://github.com/rupa/z
 [2]: https://github.com/joelthelion/autojump
+[3]: https://github.com/sorin-ionescu/oh-my-zsh/issues