|
|
|
|
@ -1,36 +1,38 @@
|
|
|
|
|
# Oh My Zsh
|
|
|
|
|
Oh My Zsh
|
|
|
|
|
=========
|
|
|
|
|
|
|
|
|
|
OMZ is a configuration framework for [Zsh](http://www.zsh.org) that enriches
|
|
|
|
|
the command line interface environment with sane defaults, aliases, functions,
|
|
|
|
|
auto completion, and prompt themes.
|
|
|
|
|
OMZ is a configuration framework for [Zsh][1] that enriches the command line
|
|
|
|
|
interface environment with sane defaults, aliases, functions, auto completion,
|
|
|
|
|
and prompt themes.
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Oh My Zsh will work with any recent release of Zsh, but the minimum recommended
|
|
|
|
|
version is 4.3.10.
|
|
|
|
|
|
|
|
|
|
1. Clone the repository:
|
|
|
|
|
1. Clone the repository:
|
|
|
|
|
|
|
|
|
|
`git clone https://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh`
|
|
|
|
|
`git clone https://github.com/sorin-ionescu/oh-my-zsh.git ~/.oh-my-zsh`
|
|
|
|
|
|
|
|
|
|
2. Initialize the submodules:
|
|
|
|
|
2. Initialize the submodules:
|
|
|
|
|
|
|
|
|
|
`cd ~/.oh-my-zsh && git submodule update --init --recursive`
|
|
|
|
|
`cd ~/.oh-my-zsh && git submodule update --init --recursive`
|
|
|
|
|
|
|
|
|
|
3. Create a new Zsh configuration by copying the Zsh template provided:
|
|
|
|
|
3. Create a new Zsh configuration by copying the Zsh template provided:
|
|
|
|
|
|
|
|
|
|
`cp ~/.oh-my-zsh/templates/zshrc ~/.zshrc`
|
|
|
|
|
`cp ~/.oh-my-zsh/templates/zshrc ~/.zshrc`
|
|
|
|
|
|
|
|
|
|
4. Set Zsh as your default shell:
|
|
|
|
|
4. Set Zsh as your default shell:
|
|
|
|
|
|
|
|
|
|
`chsh -s /bin/zsh`
|
|
|
|
|
`chsh -s /bin/zsh`
|
|
|
|
|
|
|
|
|
|
5. Open a new Zsh terminal window or tab.
|
|
|
|
|
5. Open a new Zsh terminal window or tab.
|
|
|
|
|
|
|
|
|
|
### Mac OS X
|
|
|
|
|
|
|
|
|
|
If you have administrator privileges, you must fix an Apple misconfiguration
|
|
|
|
|
in Mac OS X 10.7 Lion by renaming `/etc/zshenv` to `/etc/zprofile`, or Zsh will
|
|
|
|
|
If you have administrator privileges, you must fix an Apple misconfiguration in
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
### Troubleshooting
|
|
|
|
|
@ -46,41 +48,36 @@ accompanying README files to learn of what is available.
|
|
|
|
|
|
|
|
|
|
### Modules
|
|
|
|
|
|
|
|
|
|
1. Browse `modules/` to see what is available.
|
|
|
|
|
2. Load the modules you need in `~/.zshrc` then open a new Zsh terminal window
|
|
|
|
|
or tab.
|
|
|
|
|
1. Browse `modules/` to see what is available.
|
|
|
|
|
2. Load the modules you need in `~/.zshrc` then open a new Zsh terminal
|
|
|
|
|
window or tab.
|
|
|
|
|
|
|
|
|
|
### Themes
|
|
|
|
|
|
|
|
|
|
1. For a list of themes, type `prompt -l`.
|
|
|
|
|
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
|
|
|
|
|
tab.
|
|
|
|
|
|
|
|
|
|
1. For a list of themes, type `prompt -l`.
|
|
|
|
|
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 tab.
|
|
|
|
|
![sorin theme][2]
|
|
|
|
|
|
|
|
|
|
## Customization
|
|
|
|
|
|
|
|
|
|
The project is managed via [Git](http://git-scm.com). It is highly recommend
|
|
|
|
|
that you commit your changes and push them to [GitHub](http://github.com) to
|
|
|
|
|
not lose them. If you do not know how to use Git, follow this
|
|
|
|
|
[tutorial](http://gitimmersion.com) and bookmark this
|
|
|
|
|
[reference](http://gitref.org).
|
|
|
|
|
The project is managed via [Git][3]. It is highly recommend that you commit
|
|
|
|
|
your changes and push them to [GitHub][4] to not lose them. If you do not know
|
|
|
|
|
how to use Git, follow this [tutorial][5] and bookmark this [reference][6].
|
|
|
|
|
|
|
|
|
|
### Completions
|
|
|
|
|
|
|
|
|
|
Submit program completions to the
|
|
|
|
|
[zsh-completions](https://github.com/zsh-users/zsh-completions) project. The Oh
|
|
|
|
|
My Zsh completions directory will be synched against it.
|
|
|
|
|
Submit program completions to the [zsh-completions][7] project. The Oh My Zsh
|
|
|
|
|
completions directory will be synched against it.
|
|
|
|
|
|
|
|
|
|
## Resources
|
|
|
|
|
|
|
|
|
|
The [Zsh Reference Card](http://www.bash2zsh.com/zsh_refcard/refcard.pdf) is
|
|
|
|
|
indispensable.
|
|
|
|
|
The [Zsh Reference Card][8] is indispensable.
|
|
|
|
|
|
|
|
|
|
## Contribute
|
|
|
|
|
|
|
|
|
|
This project would not exist without all of its users and
|
|
|
|
|
[contributors](https://github.com/sorin-ionescu/oh-my-zsh/contributors).
|
|
|
|
|
This project would not exist without all of its users and [contributors][9].
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
@ -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
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
|
Sorin Ionescu
13 years ago