Converted README from Textile to Markdown and cleaned up the contents.
This commit is contained in:
Sorin Ionescu
parent
6324fcf7f1
commit
869b7e56be
2 changed files with 65 additions and 55 deletions
65
README.md
Normal file
65
README.md
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
A handful of functions, auto-complete helpers, and stuff that makes you shout...
|
||||
|
||||
> “OH MY ZSHELL!”
|
||||
|
||||
## Setup
|
||||
|
||||
`oh-my-zsh` should work with any recent release of [ZSH](http://www.zsh.org), but the
|
||||
minimum recommended version is 4.3.9.
|
||||
|
||||
1. Clone the repository.
|
||||
|
||||
`git clone git://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh`
|
||||
|
||||
2. Create a new ZSH configuration by copying the ZSH template provided.
|
||||
|
||||
**NOTE**: If you already have a `~/.zshrc` file, you should back it up with `cp
|
||||
~/.zshrc{,.orig}` in case you want to go back to your original settings.
|
||||
|
||||
cp ~/.oh-my-zsh/templates/zshrc.template.zsh ~/.zshrc
|
||||
|
||||
3. Set ZSH as your default shell:
|
||||
|
||||
`chsh -s /bin/zsh`
|
||||
|
||||
4. Start / restart ZSH by opening a new terminal window or tab.
|
||||
|
||||
### Problems?
|
||||
|
||||
If you are not able to find certain commands after switching to *Oh My ZSH*, you need
|
||||
to modify `PATH` in `~/.zshrc`.
|
||||
|
||||
## Usage
|
||||
|
||||
- Enable the plugins you want in `~/.zshrc`.
|
||||
- Browse `plugins/` to see what is available.
|
||||
- Populate the plugins array `plugins=(git osx ruby)`.
|
||||
|
||||
- Change the prompt in `~/.zshrc`.
|
||||
- For a list of themes, type `prompt -l`.
|
||||
- To preview a theme, type `prompt -p name`.
|
||||
|
||||
## Useful
|
||||
|
||||
The [ZSH Reference Card](http://www.bash2zsh.com/zsh_refcard/refcard.pdf) is tasty.
|
||||
|
||||
### Customization
|
||||
|
||||
If you have many related functions, you can organise them in a file in the
|
||||
`functions/` directory.
|
||||
|
||||
## Help out!
|
||||
|
||||
I am not a ZSH expert and suspect that there are improvements to be made. If you have
|
||||
ideas on how to make the configuration easier to maintain or improve the performance,
|
||||
do not hesitate to fork and send pull requests!
|
||||
|
||||
## Contributors
|
||||
|
||||
This project would not exist without all of our awesome users and contributors.
|
||||
|
||||
- View the growing [list](https://github.com/robbyrussell/oh-my-zsh/contributors) of
|
||||
contributors.
|
||||
|
||||
Thank you so much!
|
||||
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
A handful of functions, auto-complete helpers, and stuff that makes you shout...
|
||||
|
||||
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.
|
||||
|
||||
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
|
||||
|
||||
* 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":https://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
|
||||
|
||||
the "refcard":http://www.bash2zsh.com/zsh_refcard/refcard.pdf is pretty tasty for tips.
|
||||
|
||||
h3. Customization
|
||||
|
||||
If you have many functions which go good together you can put them as a *.plugin.zsh file in the @custom/plugins/@ directory and then enable this plugin.
|
||||
|
||||
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!
|
||||
|
||||
h2. Contributors
|
||||
|
||||
This project wouldn't exist without all of our awesome users and contributors.
|
||||
|
||||
* "View our growing list of contributors":https://github.com/robbyrussell/oh-my-zsh/contributors
|
||||
|
||||
Thank you so much!
|
||||
Loading…
Reference in a new issue