The configuration framework for Zsh
Go to file
2009-08-31 18:49:48 +01:00
themes Add geoffgarside theme 2009-08-31 18:46:48 +01:00
tools Changing order of loading zsh at end of install 2009-08-30 18:51:41 -07:00
.gitignore Adding initial gitignore file 2009-08-28 11:14:03 -07:00
aliases.zsh Swap out g alias to git 2009-08-31 13:59:34 +01:00
colors.zsh Importing initial files after reorganizing stuff. 2009-08-28 11:14:17 -07:00
completion.zsh Importing initial files after reorganizing stuff. 2009-08-28 11:14:17 -07:00
functions.zsh Add tab, take and tm functions 2009-08-31 14:03:56 +01:00
git.zsh Strip colours from git.zsh 2009-08-31 14:01:39 +01:00
grep.zsh Importing initial files after reorganizing stuff. 2009-08-28 11:14:17 -07:00
history.zsh Importing initial files after reorganizing stuff. 2009-08-28 11:14:17 -07:00
projects.zsh-example Importing initial files after reorganizing stuff. 2009-08-28 11:14:17 -07:00
prompt.zsh Merge branch master 2009-08-31 18:46:16 +01:00
rake_completion.zsh Importing initial files after reorganizing stuff. 2009-08-28 11:14:17 -07:00
README.textile Updating README with info about themes 2009-08-31 08:12:45 -07:00
zshrc Remove PATH definition as we define this in .profile 2009-08-31 18:49:48 +01:00

A handful of functions, auto-complete helpers, and stuff that makes you shout...

bq. "OH MY ZSHELL!"

h2. Setup

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

@wget http://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. Symlink the zsh config with:

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

  @ln -s ~/.oh-my-zsh/zshrc ~/.zshrc@

3. Set zsh as your default shell:

  @chsh -s /bin/zsh@

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

TODO: Update this..

* Rake autocomplete: @rake (tab)@. Will generate a cache of all your rake tasks and then let you auto-complete and/or select the task to run.
* ssh autocomplete: @ssh (tab)@ or @scp (tab)@
* Git branch, it'll tell you which branch you're in when you're in a git repository directory.
* Theme support: Change the @ZSH_THEME@ environment variable in @~/.zshrc@.
* much much more..

h2. Thanks

* Rick Olsen (technoweenie) might remember some of the configuration, which I took from a pastie a few years ago.
* Whoever created the rake autocomplete stuff, which was posted all over the internet a few years ago.

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. Send us your theme!

I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.