prezto

Archived

This repository has been archived on 2022-03-28. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

Ryan McCuaig 1a6a29e888 Add my preferred prompt		2010-04-16 08:22:50 +08:00
custom	Moving some example files into custom/	2009-09-23 08:02:58 -07:00
functions	adding homebrew completions - and a function dir	2009-10-26 00:47:23 -04:00
lib	share history with your zsh's on the same host	2010-03-31 01:31:41 +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
templates	Enabled colors in ls and made it possible to theme them	2009-11-05 20:44:28 +01:00
themes	Add my preferred prompt	2010-04-16 08:22:50 +08:00
tools	Updating check_for_upgrade script to fix issue when the LAST_EPOCH file/value got corrupted. Closes #32	2009-12-12 13:45:30 -08:00
.gitignore	merge upstream	2009-09-23 16:14:04 +01:00
oh-my-zsh.sh	Unsetting config_file after loading config	2010-05-06 21:13:59 -07:00
README.textile	gave credit to Nick for the rake autocompletion code.	2009-11-12 11:14:09 -07:00

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. Create a new zsh config by copying the zsh template we've provided.

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

@cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.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..

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.

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

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.

h3. Todo from imajes:

* need to make the title bar support git folder