1
0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-11-20 06:21:12 +00:00
prezto/README.md

104 lines
2.8 KiB
Markdown
Raw Normal View History

Prezto — Instantly Awesome Zsh
==============================
Prezto is the configuration framework for [Zsh][1]; it enriches the command line
2012-05-22 00:18:30 +00:00
interface environment with sane defaults, aliases, functions, auto completion,
and prompt themes.
2012-05-22 00:18:30 +00:00
Installation
------------
Prezto will work with any recent release of Zsh, but the minimum required
version is 4.3.17.
1. Launch Zsh:
`zsh`
2. Clone the repository:
`git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"`
3. Create a new Zsh configuration by copying the Zsh configuration files
provided:
```
setopt EXTENDED_GLOB
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
2012-09-04 13:12:52 +00:00
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
done
```
2017-04-13 10:27:59 +00:00
Note: If you already have any of the given config files, ln will error. In
simple cases you can add `source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to
the bottom of your `.zshrc` to load prezto but keep your config intact. For
more complicated setups, it is recommended that you back up your original
configs and replace them with the provided prezto runcoms.
4. Set Zsh as your default shell:
`chsh -s /bin/zsh`
5. Open a new Zsh terminal window or tab.
2011-12-30 03:55:45 +00:00
### Troubleshooting
If you are not able to find certain commands after switching to *Prezto*,
modify the `PATH` variable in *~/.zprofile* then open a new Zsh terminal
2011-12-30 03:55:45 +00:00
window or tab.
Updating
--------
Pull the latest changes and update submodules.
git pull && git submodule update --init --recursive
Usage
-----
Prezto has many features disabled by default. Read the source code and
2011-12-30 03:55:45 +00:00
accompanying README files to learn of what is available.
2012-03-28 16:41:39 +00:00
### Modules
1. Browse */modules* to see what is available.
2. Load the modules you need in *~/.zpreztorc* then open a new Zsh terminal
window or tab.
2011-12-30 03:55:45 +00:00
### 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 *~/.zpreztorc* then open a new Zsh terminal
window or tab.
![sorin theme][2]
Customization
-------------
The project is managed via [Git][3]. It is highly recommended that you fork this
project; so, that you can 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].
Resources
---------
2012-08-28 00:17:36 +00:00
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
License
-------
2011-12-28 22:04:43 +00:00
This project is licensed under the MIT License.
2011-12-28 22:04:43 +00:00
2012-05-22 00:18:30 +00:00
[1]: http://www.zsh.org
2015-05-19 21:39:00 +00:00
[2]: http://i.imgur.com/nrGV6pg.png "sorin theme"
2012-05-22 00:18:30 +00:00
[3]: http://git-scm.com
[4]: https://github.com
[5]: http://gitimmersion.com
[6]: http://gitref.org
2012-08-28 00:17:36 +00:00
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
[8]: http://grml.org/zsh/zsh-lovers.html