README.textile
14b219b5
 A handful of functions, auto-complete helpers, and stuff that makes you shout...
 
 bq. "OH MY ZSHELL!"
 
5da20b9d
 h2. Setup
 
3bc73012
 @oh-my-zsh@ should work with any recent release of "zsh":http://www.zsh.org/, the minimum recommended version is 4.3.9.
 
43fd24e8
 h3. The automatic installer... (do you trust me?)
 
ab1cbe90
 @wget https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh@
43fd24e8
 
 h3. The manual way
 
 
4e2b71ba
 1. Clone the repository
 
908fead3
   @git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
4e2b71ba
 
d1a9efc4
 2. Create a new zsh config by copying the zsh template we've provided.
4e2b71ba
 
1092aba5
   *NOTE*: If you already have a ~/.zshrc file, you should back it up. @cp ~/.zshrc ~/.zshrc.orig@ in case you want to go back to your original settings.
 
d1a9efc4
   @cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
95f32b4f
 
 3. Set zsh as your default shell:
 
   @chsh -s /bin/zsh@
 
b26ff059
 4. Start / restart zsh (open a new terminal is easy enough...)
4e2b71ba
 
dcd664e4
 h3. Problems?
 
b26ff059
 You _might_ need to modify your PATH in ~/.zshrc if you're not able to find some commands after switching to _Oh My Zsh_.
dcd664e4
 
d1e1869a
 h2. Usage
 
b26ff059
 * enable the plugins you want in your @~/.zshrc@ (take a look at @plugins/@ to see what's possible)
 ** example: @plugins=(git osx ruby)@
5af0ba8f
 * Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
ab1cbe90
 ** Take a look at the "current themes":https://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with _Oh My Zsh_.
b26ff059
 * much much more...  take a look at @lib/@ what _Oh My Zsh_ offers...
4e2b71ba
 
1304baf9
 h2. Useful
8a8a7baf
 
1304baf9
 the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips.
 
1dc73537
 h3. Customization
 
 If you want to override any of the default behavior, just add a new file (ending in @.zsh@) into the @custom/@ directory.
b26ff059
 If you have many functions which go good together you can put them as a *.plugin.zsh file in the @plugin/@ directory and then enable this plugin.
1dc73537
 
e1f5c0c7
 h3. Uninstalling
 
 If you want to uninstall it, just run @uninstall_oh_my_zsh@ from the command line and it'll remove itself and revert you to bash (or your previous zsh config).
 
14b219b5
 h2. Thanks
 
81acebee
 * Rick Olson (technoweenie) might remember some of the configuration, which I took from a pastie a few years ago.
 * Marcel (noradio) provided Rick the original zsh configuration.
 * Nicholas (ulysses) for the "rake autocompletion code":http://weblog.rubyonrails.org/2006/3/9/fast-rake-task-completion-for-zsh.
5da20b9d
 
14b219b5
 h2. Help out!
5da20b9d
 
c1ac59d2
 I'm far from being a zsh-expert and suspect there are many ways to improve. If you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!
 
5af0ba8f
 h3. Send us your theme!
 
b26ff059
 I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.