updated README for my fork

This commit is contained in:
Mike Hostetler 2010-03-30 16:22:00 +00:00 committed by Mike Hostetler
commit 5985699010

View file

@ -2,18 +2,16 @@ A handful of functions, auto-complete helpers, and stuff that makes you shout...
bq. "OH MY ZSHELL!"
This is forked from http://github.com/robbyrussell/oh-my-zsh
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
h3. The manual install
1. Clone the repository
@git clone git://github.com/robbyrussell/oh-my-zsh.git ~/.oh-my-zsh@
@git clone http://github.com/squarepegsys/oh-my-zsh.git ~/.oh-my-zsh@
2. Create a new zsh config by copying the zsh template we've provided.
@ -35,12 +33,12 @@ 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..
o auto rehash
o Put in Terminal configurator for those strange terminal settings
o easier support for more SCM's (now it's mostly Git)
o Have different zsh on the same machine share history
o Put in some Django shortcuts
o More to come
h2. Useful
@ -56,18 +54,14 @@ If you want to uninstall it, just run @uninstall_oh_my_zsh@ from the command lin
h2. Thanks
* Robby Russell for starting this project in the first place
* 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!
I just quote robbyrussel:
bq. 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
I would love more advance yet nice ZSH stuff\