diff options
| author | Robby Russell <robby@planetargon.com> | 2010-06-10 07:50:24 -0700 |
|---|---|---|
| committer | Robby Russell <robby@planetargon.com> | 2010-06-10 07:50:24 -0700 |
| commit | 7c279856ed4f244a504e5fc89201ab0be86eade5 (patch) | |
| tree | 8374a738cb30be059fbdf2752d9c80d609abbab6 /README.textile | |
| parent | 7f350da5b74c65ed99766c8ebd5137aee9479225 (diff) | |
| parent | b26ff059653716fd38d1813b797572bbec718c16 (diff) | |
| download | zsh-7c279856ed4f244a504e5fc89201ab0be86eade5.tar.gz zsh-7c279856ed4f244a504e5fc89201ab0be86eade5.tar.bz2 zsh-7c279856ed4f244a504e5fc89201ab0be86eade5.zip | |
Merge branch 'master' of github.com:robbyrussell/oh-my-zsh
Diffstat (limited to 'README.textile')
| -rw-r--r-- | README.textile | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/README.textile b/README.textile index 950f8861b..8b1b6875a 100644 --- a/README.textile +++ b/README.textile @@ -4,6 +4,8 @@ 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?) @wget http://github.com/robbyrussell/oh-my-zsh/raw/master/tools/install.sh -O - | sh@ @@ -25,22 +27,19 @@ h3. The manual way @chsh -s /bin/zsh@ -4. Start / restart zsh (open a new terminal is easy enough..) +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. +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. +* 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":http://wiki.github.com/robbyrussell/oh-my-zsh/themes that come bundled with Oh My Zsh. -* much much more.. +** 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... take a look at @lib/@ what _Oh My Zsh_ offers... h2. Useful @@ -49,6 +48,7 @@ the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty fo 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 good together you can put them as a *.plugin.zsh file in the @plugin/@ directory and then enable this plugin. h3. Uninstalling @@ -66,8 +66,4 @@ I'm far from being a zsh-expert and suspect there are many ways to improve. If y 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
\ No newline at end of file +I'm hoping to collect a bunch of themes for our command prompts. You can see existing ones in the @themes/@ directory.
\ No newline at end of file |