Clean up READMEs

13 years ago · 075f516763
parent a4cf629c2f
commit 075f516763
16 changed files with 162 additions and 136 deletions
--- a/README.md
+++ b/README.md
@ -1,10 +1,12 @@
-# Oh My Zsh
+Oh My Zsh
+=========

-OMZ is a configuration framework for [Zsh](http://www.zsh.org) that enriches
-the command line interface environment with sane defaults, aliases, functions,
-auto completion, and prompt themes.
+OMZ is a configuration framework for [Zsh][1] that enriches the command line
+interface environment with sane defaults, aliases, functions, auto completion,
+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.
@ -29,8 +31,8 @@ version is 4.3.10.

 ### Mac OS X

-If you have administrator privileges, you must fix an Apple misconfiguration
-in Mac OS X 10.7 Lion by renaming `/etc/zshenv` to `/etc/zprofile`, or Zsh will
+If you have administrator privileges, you must fix an Apple misconfiguration in
+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
@ -47,40 +49,35 @@ accompanying README files to learn of what is available.
 ### Modules

   1. Browse `modules/` to see what is available.
-2. Load the modules you need in `~/.zshrc` then open a new Zsh terminal window
-   or tab.
+   2. Load the modules you need in `~/.zshrc` then open a new Zsh terminal
+      window or tab.

 ### Themes

   1. For a list of themes, type `prompt -l`.
   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
-   tab.
-   ![sorin theme](http://i.imgur.com/aipDQ.png "sorin theme")
+   3. Load the theme you like in `~/.zshrc` then open a new Zsh terminal window
+      or tab.
+      ![sorin theme][2]

 ## Customization

-The project is managed via [Git](http://git-scm.com). It is highly recommend
-that you commit your changes and push them to [GitHub](http://github.com) to
-not lose them. If you do not know how to use Git, follow this
-[tutorial](http://gitimmersion.com) and bookmark this
-[reference](http://gitref.org).
+The project is managed via [Git][3]. It is highly recommend that you commit
+your changes and push them to [GitHub][4] to not lose them. If you do not know
+how to use Git, follow this [tutorial][5] and bookmark this [reference][6].

 ### Completions

-Submit program completions to the
-[zsh-completions](https://github.com/zsh-users/zsh-completions) project. The Oh
-My Zsh completions directory will be synched against it.
+Submit program completions to the [zsh-completions][7] project. The Oh My Zsh
+completions directory will be synched against it.

 ## Resources

-The [Zsh Reference Card](http://www.bash2zsh.com/zsh_refcard/refcard.pdf) is
-indispensable.
+The [Zsh Reference Card][8] is indispensable.

 ## Contribute

-This project would not exist without all of its users and
-[contributors](https://github.com/sorin-ionescu/oh-my-zsh/contributors).
+This project would not exist without all of its users and [contributors][9].

 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
+
--- a/modules/command-not-found/README.md
+++ b/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

--- a/modules/completion/README.md
+++ b/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

--- a/modules/directory/README.md
+++ b/modules/directory/README.md
@ -27,8 +27,10 @@ Aliases
 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)
- - [Sorin Ionescu](/sorin-ionescu)
+  - [James Cox](https://github.com/imajes)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues

--- a/modules/gnu-utility/README.md
+++ b/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

--- a/modules/haskell/README.md
+++ b/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

--- a/modules/history-substring-search/README.md
+++ b/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)
- - [Suraj N. Kurapati](/sunaku)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+  - [Suraj N. Kurapati](https://github.com/sunaku)

 [1]: http://fishshell.com
+[2]: https://github.com/sorin-ionescu/oh-my-zsh/issues

--- a/modules/history/README.md
+++ b/modules/history/README.md
@ -35,10 +35,11 @@ Aliases
 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)
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Robby Russell](https://github.com/robbyrussell)
+  - [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

--- a/modules/osx/README.md
+++ b/modules/osx/README.md
@ -1,10 +1,11 @@
 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.
  - `pushdf` push the current working directory onto the directory queue and
  - `ql` quick look at files.
@ -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

--- a/modules/prompt/README.md
+++ b/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
-name of the theme you wish to load. Setting it to **random** will load a random
-theme.
+To select a prompt theme, add the following to *zshrc*, and replace **name**
+with the name of the theme you wish to load. Setting it to **random** will load
+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

--- a/modules/python/README.md
+++ b/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)
- - [Sebastian Wiesner](/lunaryorn)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+  - [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

--- a/modules/screen/README.md
+++ b/modules/screen/README.md
@ -1,5 +1,5 @@
-screen
-======
+GNU Screen
+==========

 Defines [GNU Screen][1] aliases and provides for auto launching it at start-up.

@ -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

--- a/modules/tmux/README.md
+++ b/modules/tmux/README.md
@ -1,4 +1,4 @@
-tmux
+Tmux
 ====

 Defines [tmux][1] aliases and provides for auto launching it at start-up.
@ -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)
- - [Colin Hebert](/ColinHebert)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+  - [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

--- a/modules/utility/README.md
+++ b/modules/utility/README.md
@ -22,9 +22,11 @@ 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][1].*

- - [Robby Russell](/robbyrussell)
- - [Suraj N. Kurapati](/sunaku)
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Robby Russell](https://github.com/robbyrussell)
+  - [Suraj N. Kurapati](https://github.com/sunaku)
+  - [Sorin Ionescu](https://github.com/sorin-ionescu)
+
+[1]: https://github.com/sorin-ionescu/oh-my-zsh/issues

--- a/modules/wakeonlan/README.md
+++ b/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)
- - [Sorin Ionescu](/sorin-ionescu)
+  - [Paul Dann](https://github.com/giddie)
+  - [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

--- a/modules/z/README.md
+++ b/modules/z/README.md
@ -1,4 +1,4 @@
-z
+Z
 =

 Maintains a frequently used directory list for fast directory changes. For more
@ -13,10 +13,11 @@ Aliases
 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