This repository has been archived on 2022-03-28. You can view files and clone it, but cannot push or open issues or pull requests.
prezto/README.md

117 lines
3.5 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-21 20:18:30 -04:00
interface environment with sane defaults, aliases, functions, auto completion,
and prompt themes.
2012-05-21 20:18:30 -04: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 09:12:52 -04:00
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
done
4. Set Zsh as your default shell:
chsh -s /bin/zsh
5. Open a new Zsh terminal window or tab.
2011-12-29 22:55:45 -05: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-29 22:55:45 -05: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-29 22:55:45 -05:00
accompanying README files to learn of what is available.
2012-03-28 12:41:39 -04: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-29 22:55:45 -05: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-27 20:17:36 -04:00
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
License
-------
2011-12-28 17:04:43 -05:00
(The MIT License)
2013-12-06 17:13:36 -05:00
Copyright (c) 2009-2011 Robby Russell and contributors.
Copyright (c) 2011-2014 Sorin Ionescu and contributors.
2011-12-28 17:04:43 -05:00
2011-12-29 22:55:45 -05:00
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
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.
2011-12-28 17:04:43 -05:00
2012-05-21 20:18:30 -04:00
[1]: http://www.zsh.org
2012-09-25 17:25:29 -04:00
[2]: http://i.imgur.com/nBEEZ.png "sorin theme"
2012-05-21 20:18:30 -04:00
[3]: http://git-scm.com
[4]: https://github.com
[5]: http://gitimmersion.com
[6]: http://gitref.org
2012-08-27 20:17:36 -04:00
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
[8]: http://grml.org/zsh/zsh-lovers.html