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 a4471665ba
Adding zsh_stats function to show you which commands you run the most.
15 years ago
log Adding a file into log/ so that we have a log file to record history to 15 years ago
themes Adding Evan's skinny, topless prompt. 15 years ago
tools Changing order of loading zsh at end of install 15 years ago
.gitignore Adding initial gitignore file 15 years ago
README.textile Updating README with info about themes 15 years ago
aliases.zsh Removed a bunch of aliases that I never use, which came from someone else I copied old config from 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 zsh_stats function to show you which commands you run the most. 15 years ago
git.zsh Only calling git symbolic-ref HEAD when we are in a .git directory 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
projects.zsh-example Importing initial files after reorganizing stuff. 15 years ago
prompt.zsh Adding theme support so that people can share their zsh prompts with others. Users can set which theme to load in zshrc now. 15 years ago
rake_completion.zsh Importing initial files after reorganizing stuff. 15 years ago
zshrc Adding theme support so that people can share their zsh prompts with others. Users can set which theme to load in zshrc now. 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@.
* much much more..

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.