Conflicts:
	README.textile
	templates/zshrc.zsh-template
	tools/install.sh
This commit is contained in:
Yin Hou 2014-07-02 16:59:39 +08:00
commit 440c06ba31
191 changed files with 6734 additions and 1397 deletions

View file

@ -10,24 +10,35 @@ h2. Setup
h3. The automatic installer... (do you trust me?)
You can install this via the command line with either `curl` or `wget`.
You can install this via the command line with either @curl@ or @wget@.
h4. via `curl`
h4. via @curl@
@curl -L http://install.ohmyz.sh | sh@
@curl -L https://github.com/yinhou/oh-my-zsh/raw/master/tools/install.sh | sh@
h4. via `wget`
h4. via @wget@
@wget --no-check-certificate http://install.ohmyz.sh -O - | sh@
h4. Optional: change the install directory
The default location is @~/.oh-my-zsh@ (hidden in your home directory).
You can change the install directory with the ZSH environment variable, either
by running @export ZSH=/your/path@ before installing, or setting it before the
end of the install pipeline like this:
@curl -L https://raw.github.com/robbyrussell/oh-my-zsh/master/tools/install.sh | ZSH=~/.dotfiles/zsh sh@
@wget --no-check-certificate https://github.com/yinhou/oh-my-zsh/raw/master/tools/install.sh -O - | sh@
h3. The manual way
1. Clone the repository
@git clone git://github.com/yin/oh-my-zsh.git ~/.oh-my-zsh@
2. *OPTIONAL* Backup your existing ~/.zshrc file
2. *OPTIONAL* Backup your existing @~/.zshrc@ file
@cp ~/.zshrc ~/.zshrc.orig@
@ -35,7 +46,6 @@ h3. The manual way
@cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
4. Set zsh as your default shell:
@chsh -s /bin/zsh@
@ -44,11 +54,13 @@ h3. The manual way
h3. Problems?
You _might_ need to modify your PATH in ~/.zshrc if you're not able to find some commands after switching to _Oh My Zsh_.
You _might_ need to modify your @PATH@ in @~/.zshrc@ if you're not able to find some commands after switching to _Oh My Zsh_.
If you installed manually or changed the install location, check ZSH in @~/.zshrc@
h2. Usage
* enable the plugins you want in your @~/.zshrc@ (take a look at @plugins/@ to see what's possible)
* enable the plugins you want in your @~/.zshrc@ (take a look at the @plugins/@ directory and the "wiki":https://github.com/robbyrussell/oh-my-zsh/wiki/Plugins to see what's possible)
** example: @plugins=(git osx ruby)@
* Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
** Take a look at the "current themes":https://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with _Oh My Zsh_.
@ -61,16 +73,16 @@ the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty fo
h3. Customization
If you want to override any of the default behavior, just add a new file (ending in @.zsh@) into the @custom/@ directory.
If you have many functions which go well together you can put them as a *.plugin.zsh file in the @custom/plugins/@ directory and then enable this plugin.
If you have many functions which go well together you can put them as a @*.plugin.zsh@ file in the @custom/plugins/@ directory and then enable this plugin.
If you would like to override the functionality of a plugin distributed with oh-my-zsh, create a plugin of the same name in the @custom/plugins/@ directory and it will be loaded instead of the one in @plugins/@.
h3. Updates
By default you will be prompted to check for updates. If you would like oh-my-zsh to automatically update itself without prompting you, set the following in your ~/.zshrc
By default you will be prompted to check for updates. If you would like oh-my-zsh to automatically update itself without prompting you, set the following in your @~/.zshrc@
@DISABLE_UPDATE_PROMPT=true@
To disable updates entirely, put this in your ~/.zshrc
To disable updates entirely, put this in your @~/.zshrc@
@DISABLE_AUTO_UPDATE=true@