|
|
@ -1,10 +1,12 @@ |
|
|
|
# Oh My Zsh |
|
|
|
Oh My Zsh |
|
|
|
|
|
|
|
========= |
|
|
|
|
|
|
|
|
|
|
|
OMZ is a configuration framework for [Zsh](http://www.zsh.org) that enriches |
|
|
|
OMZ is a configuration framework for [Zsh][1] that enriches the command line |
|
|
|
the command line interface environment with sane defaults, aliases, functions, |
|
|
|
interface environment with sane defaults, aliases, functions, auto completion, |
|
|
|
auto completion, and prompt themes. |
|
|
|
and prompt themes. |
|
|
|
|
|
|
|
|
|
|
|
## Installation |
|
|
|
Installation |
|
|
|
|
|
|
|
------------ |
|
|
|
|
|
|
|
|
|
|
|
Oh My Zsh will work with any recent release of Zsh, but the minimum recommended |
|
|
|
Oh My Zsh will work with any recent release of Zsh, but the minimum recommended |
|
|
|
version is 4.3.10. |
|
|
|
version is 4.3.10. |
|
|
@ -29,8 +31,8 @@ version is 4.3.10. |
|
|
|
|
|
|
|
|
|
|
|
### Mac OS X |
|
|
|
### Mac OS X |
|
|
|
|
|
|
|
|
|
|
|
If you have administrator privileges, you must fix an Apple misconfiguration |
|
|
|
If you have administrator privileges, you must fix an Apple misconfiguration in |
|
|
|
in Mac OS X 10.7 Lion by renaming `/etc/zshenv` to `/etc/zprofile`, or Zsh will |
|
|
|
Mac OS X 10.7 Lion by renaming `/etc/zshenv` to `/etc/zprofile`, or Zsh will |
|
|
|
have the wrong `PATH` when executed non-interactively by scripts. |
|
|
|
have the wrong `PATH` when executed non-interactively by scripts. |
|
|
|
|
|
|
|
|
|
|
|
### Troubleshooting |
|
|
|
### Troubleshooting |
|
|
@ -47,40 +49,35 @@ accompanying README files to learn of what is available. |
|
|
|
### Modules |
|
|
|
### Modules |
|
|
|
|
|
|
|
|
|
|
|
1. Browse `modules/` to see what is available. |
|
|
|
1. Browse `modules/` to see what is available. |
|
|
|
2. Load the modules you need in `~/.zshrc` then open a new Zsh terminal window |
|
|
|
2. Load the modules you need in `~/.zshrc` then open a new Zsh terminal |
|
|
|
or tab. |
|
|
|
window or tab. |
|
|
|
|
|
|
|
|
|
|
|
### Themes |
|
|
|
### Themes |
|
|
|
|
|
|
|
|
|
|
|
1. For a list of themes, type `prompt -l`. |
|
|
|
1. For a list of themes, type `prompt -l`. |
|
|
|
2. To preview a theme, type `prompt -p name`. |
|
|
|
2. To preview a theme, type `prompt -p name`. |
|
|
|
3. Load the theme you like in `~/.zshrc` then open a new Zsh terminal window or |
|
|
|
3. Load the theme you like in `~/.zshrc` then open a new Zsh terminal window |
|
|
|
tab. |
|
|
|
or tab. |
|
|
|
![sorin theme](http://i.imgur.com/aipDQ.png "sorin theme") |
|
|
|
![sorin theme][2] |
|
|
|
|
|
|
|
|
|
|
|
## Customization |
|
|
|
## Customization |
|
|
|
|
|
|
|
|
|
|
|
The project is managed via [Git](http://git-scm.com). It is highly recommend |
|
|
|
The project is managed via [Git][3]. It is highly recommend that you commit |
|
|
|
that you commit your changes and push them to [GitHub](http://github.com) to |
|
|
|
your changes and push them to [GitHub][4] to not lose them. If you do not know |
|
|
|
not lose them. If you do not know how to use Git, follow this |
|
|
|
how to use Git, follow this [tutorial][5] and bookmark this [reference][6]. |
|
|
|
[tutorial](http://gitimmersion.com) and bookmark this |
|
|
|
|
|
|
|
[reference](http://gitref.org). |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Completions |
|
|
|
### Completions |
|
|
|
|
|
|
|
|
|
|
|
Submit program completions to the |
|
|
|
Submit program completions to the [zsh-completions][7] project. The Oh My Zsh |
|
|
|
[zsh-completions](https://github.com/zsh-users/zsh-completions) project. The Oh |
|
|
|
completions directory will be synched against it. |
|
|
|
My Zsh completions directory will be synched against it. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Resources |
|
|
|
## Resources |
|
|
|
|
|
|
|
|
|
|
|
The [Zsh Reference Card](http://www.bash2zsh.com/zsh_refcard/refcard.pdf) is |
|
|
|
The [Zsh Reference Card][8] is indispensable. |
|
|
|
indispensable. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Contribute |
|
|
|
## Contribute |
|
|
|
|
|
|
|
|
|
|
|
This project would not exist without all of its users and |
|
|
|
This project would not exist without all of its users and [contributors][9]. |
|
|
|
[contributors](https://github.com/sorin-ionescu/oh-my-zsh/contributors). |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
If you have ideas on how to make the configuration easier to maintain or |
|
|
|
If you have ideas on how to make the configuration easier to maintain or |
|
|
|
improve its performance, do not hesitate to fork and send pull requests. |
|
|
|
improve its performance, do not hesitate to fork and send pull requests. |
|
|
@ -109,3 +106,13 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|
|
|
SOFTWARE. |
|
|
|
SOFTWARE. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[1]: http://www.zsh.org |
|
|
|
|
|
|
|
[2]: http://i.imgur.com/aipDQ.png "sorin theme" |
|
|
|
|
|
|
|
[3]: http://git-scm.com |
|
|
|
|
|
|
|
[4]: https://github.com |
|
|
|
|
|
|
|
[5]: http://gitimmersion.com |
|
|
|
|
|
|
|
[6]: http://gitref.org |
|
|
|
|
|
|
|
[7]: https://github.com/zsh-users/zsh-completions |
|
|
|
|
|
|
|
[8]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf |
|
|
|
|
|
|
|
[9]: https://github.com/sorin-ionescu/oh-my-zsh/contributors |
|
|
|
|
|
|
|
|
|
|
|