1
0
Fork 0
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.
Go to file
Christopher Sexton a9f21b381c
Improved git prompt handling
15 years ago
log Adding a file into log/ so that we have a log file to record history to 15 years ago
templates Updating install process to copy your current environments PATH and adding it to the bottom of ~/.zshrc. 15 years ago
themes Added risto theme and made git.zsh themable 15 years ago
tools Updating install process to copy your current environments PATH and adding it to the bottom of ~/.zshrc. 15 years ago
.gitignore Adding initial gitignore file 15 years ago
README.textile Updating README to instruct people to copy the .zshrc template file versus symlinking it. 15 years ago
aliases.zsh Adding more useful aliases for Git. 15 years ago
colors.zsh Importing initial files after reorganizing stuff. 15 years ago
completion.zsh added case-insensitive auto completion 15 years ago
functions.zsh Adding an upgrade_oh_my_zsh function to... well, upgrade Oh My Zsh 15 years ago
git.zsh Improved git prompt handling 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
key-bindings.zsh Moving bindings into their own file. Updating aliases after moving out bindings 15 years ago
oh-my-zsh.sh Trying out some zsh-fu. Using the for x (*.zsh) source approach 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 Updating the name of the rake and capistrano task cache file to append a ~ to the end of the filename so it's easier to ignore in rails git projects. [#1] 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. 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..

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.