README.textile 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. 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...
  2. bq. "OH MY ZSHELL!"
  3. h2. Setup
  4. @oh-my-zsh@ should work with any recent release of "zsh":http://www.zsh.org/, the minimum recommended version is 4.3.9.
  5. h3. The automatic installer... (do you trust me?)
  6. You can install this via the command line with either `curl` or `wget`.
  7. h4. via `curl`
  8. @curl -L https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh | sh@
  9. h4. via `wget`
  10. @wget --no-check-certificate https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh@
  11. h3. The manual way
  12. 1. Clone the repository
  13. @git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
  14. 2. *OPTIONAL* Backup your existing ~/.zshrc file
  15. @cp ~/.zshrc ~/.zshrc.orig@
  16. 3. Create a new zsh config by copying the zsh template we've provided.
  17. @cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@
  18. 4. Set zsh as your default shell:
  19. @chsh -s /bin/zsh@
  20. 5. Start / restart zsh (open a new terminal is easy enough...)
  21. h3. Problems?
  22. You _might_ need to modify your PATH in ~/.zshrc if you're not able to find some commands after switching to _Oh My Zsh_.
  23. h2. Usage
  24. * enable the plugins you want in your @~/.zshrc@ (take a look at @plugins/@ to see what's possible)
  25. ** example: @plugins=(git osx ruby)@
  26. * Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
  27. ** Take a look at the "current themes":https://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with _Oh My Zsh_.
  28. * much much more... take a look at @lib/@ what _Oh My Zsh_ offers...
  29. h2. Useful
  30. the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips.
  31. h3. Customization
  32. If you want to override any of the default behavior, just add a new file (ending in @.zsh@) into the @custom/@ directory.
  33. 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.
  34. 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/@.
  35. h3. Updates
  36. 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
  37. @DISABLE_UPDATE_PROMPT=true@
  38. To disable updates entirely, put this in your ~/.zshrc
  39. @DISABLE_AUTO_UPDATE=true@
  40. h3. Uninstalling
  41. 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).
  42. h2. Help out!
  43. 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!
  44. h3. (Don't) Send us your theme! (for now)
  45. -I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.-
  46. 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.
  47. h2. Contributors
  48. This project wouldn't exist without all of our awesome users and contributors.
  49. * "View our growing list of contributors":https://github.com/robbyrussell/oh-my-zsh/contributors
  50. Thank you so much!