The configuration framework for Zsh
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Robby Russell 010e76f154
Renaming template file one last time (for now)
15 years ago
log Adding a file into log/ so that we have a log file to record history to 15 years ago
templates Renaming template file one last time (for now) 15 years ago
themes Added extra theme with full pathnames and hostname 15 years ago
tools Adding an upgrade_oh_my_zsh function to... well, upgrade Oh My Zsh 15 years ago
.gitignore Adding initial gitignore file 15 years ago
README.textile Including a link to the Themes wiki page from the README 15 years ago
aliases.zsh Remove colour from ls command 15 years ago
colors.zsh Importing initial files after reorganizing stuff. 15 years ago
completion.zsh Importing initial files after reorganizing stuff. 15 years ago
functions.zsh Adding an upgrade_oh_my_zsh function to... well, upgrade Oh My Zsh 15 years ago
git.zsh Merging geoffgarside work 15 years ago
grep.zsh Importing initial files after reorganizing stuff. 15 years ago
history.zsh Importing initial files after reorganizing stuff. 15 years ago
oh-my-zsh.sh Moving the loading of all .zsh files into a different file so that we can remove zshrc from the repository 15 years ago
projects.zsh-example Importing initial files after reorganizing stuff. 15 years ago
prompt.zsh Merge branch master 15 years ago
rake_completion.zsh Importing initial files after reorganizing stuff. 15 years ago

README.textile

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@.
** Take a look at the "current themes":http://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with Oh My Zsh.
* much much more..

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