Custom zsh default settings !! [ONLY FOR DEBIAN / UBUNTU] !!
Go to file
Robby Russell 0118b5b759 Merge pull request #1248 from grahamc/add-symfony
Adding a symfony plugin, for symfony 1
2012-12-04 06:56:59 -08:00
custom fixes my wrong commit - fixes #1423 2012-11-25 20:34:12 -02:00
lib Merge pull request #1258 from caio/git-branch-status 2012-12-04 06:56:43 -08:00
log Adding a file into log/ so that we have a log file to record history to 2009-08-31 11:17:05 -07:00
plugins Merge pull request #1248 from grahamc/add-symfony 2012-12-04 06:56:59 -08:00
templates Modifying documentation in zshrc template for new config option 2012-11-30 05:58:08 -08:00
themes Merge pull request #794 from markdrago/cloud_parameter 2012-12-04 06:52:32 -08:00
tools Fixing conflict in install scripts 2012-12-02 13:08:06 -08:00
.gitignore Merge branch 'master' of git@github.com:fred-o/oh-my-zsh 2011-12-08 10:02:17 +01:00
oh-my-zsh.sh Expand for-loop so that it works under Snow Leopard Terminal.app. 2012-10-30 22:42:52 +00:00
README.textile Make the NOTE an optional for improved instructions 2012-12-01 21:10:23 -05:00

A handful of functions, auto-complete helpers, and stuff that makes 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.

h3. The automatic installer... (do you trust me?)

You can install this via the command line with either `curl` or `wget`.

h4. via `curl`

@curl -L https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh | sh@

h4. via `wget`

@wget --no-check-certificate https://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | 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

  @cp ~/.zshrc ~/.zshrc.orig@

3. Create a new zsh config by copying the zsh template we've provided.

  @cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc@


4. Set zsh as your default shell:

  @chsh -s /bin/zsh@

5. Start / restart zsh (open a new terminal is easy enough...)

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_.

h2. Usage

* enable the plugins you want in your @~/.zshrc@ (take a look at @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_.
* much much more...  take a look at @lib/@ what _Oh My Zsh_ offers...

h2. Useful

the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips.

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 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. 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).

h2. Help out!

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!

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. 



h2. Contributors

This project wouldn't exist without all of our awesome users and contributors.

* "View our growing list of contributors":https://github.com/robbyrussell/oh-my-zsh/contributors

Thank you so much!