linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2026-02-20 03:02:29 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'master' of github.com:robbyrussell/oh-my-zsh

Browse source 
Conflicts:
	README.textile
	templates/zshrc.zsh-template
	tools/install.sh
This commit is contained in:
Spencer Comerford 2014-08-04 17:19:45 -06:00
commit 981e6c1765
144 changed files with 4521 additions and 1330 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.textile
View file

@ -7,27 +7,38 @@ bq. "OH MY ZSHELL!"
h2. Setup
@oh-my-zsh@ should work with any recent release of "zsh":http://www.zsh.org/, the minimum recommended version is 4.3.9.
If not already, install zsh using the command line first.
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 https://raw.githubusercontent.com/Spencevail/oh-my-zsh/master/tools/install.sh | sh@
h4. via `wget`
h4. via @wget@
@wget --no-check-certificate https://raw.githubusercontent.com/Spencevail/oh-my-zsh/master/tools/install.sh -O - | sh@
h3. The manual way
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@
h3. The manual way
1. Clone the repository
@git clone git://github.com/Spencevail/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@