diff options
Diffstat (limited to 'README.textile')
| -rw-r--r-- | README.textile | 52 |
1 files changed, 37 insertions, 15 deletions
diff --git a/README.textile b/README.textile index 0a4545bac..5900c95d8 100644 --- a/README.textile +++ b/README.textile @@ -1,32 +1,44 @@ -A handful of functions, auto-complete helpers, and stuff that makes you shout... +!https://s3.amazonaws.com/ohmyzsh/oh-my-zsh-logo.png! +oh-my-zsh is an open source, community-driven framework for managing your ZSH configuration. It comes bundled with a ton of helpful functions, helpers, plugins, themes, and few things that make you shout... 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://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh | sh@ +@curl -L http://install.ohmyz.sh | sh@ -h4. via `wget` +h4. via @wget@ -@wget --no-check-certificate https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh@ +@wget --no-check-certificate http://install.ohmyz.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/robbyrussell/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@ @@ -34,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@ @@ -43,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_. @@ -60,9 +73,20 @@ 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@ + +@DISABLE_UPDATE_PROMPT=true@ + +To disable updates entirely, put this in your @~/.zshrc@ + +@DISABLE_AUTO_UPDATE=true@ + +To upgrade directly from the command line, just run @upgrade_oh_my_zsh@ h3. Uninstalling @@ -76,9 +100,7 @@ h3. (Don't) Send us your theme! (for now) -I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.- -We have enough themes for the time being. Please fork the project and add on in there, you can let people know how to grab it from there. - - +We have enough themes for the time being. Please fork the project and add on in there, you can let people know how to grab it from there. h2. Contributors |