Archived

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.

Go to file

Caleb Land 817dd3aa3a Allow functions in a module to be symlinks Add the '-' flag to the function glob which makes the other flag test against the target of the symlink, and not the symlink itself. When using rcm (https://github.com/thoughtbot/rcm), the function files are symlinked by default, but the current glob excludes them by targeting normal files (with the '.' flag). Signed-off-by: Sorin Ionescu <sorin.ionescu@gmail.com>		2014-01-03 13:30:55 -05:00
modules	Refactor Bundler aliases	2013-11-30 19:25:11 -05:00
runcoms	Fix heading level for "zpreztorc"	2013-11-29 17:34:34 -05:00
.gitignore	[#23 ] Rename plugins to modules	2012-04-05 13:39:40 -04:00
.gitmodules	[#129 , #211 ] Remove z	2012-09-30 16:29:41 -04:00
CONTRIBUTING.md	[Fix #293 ] Add CONTRIBUTING.md	2012-09-25 13:17:16 -04:00
init.zsh	Allow functions in a module to be symlinks	2014-01-03 13:30:55 -05:00
README.md	Update copyright	2013-12-08 01:34:27 -05:00

README.md

Prezto — Instantly Awesome Zsh

Prezto is the configuration framework for Zsh; it enriches the command line interface environment with sane defaults, aliases, functions, auto completion, and prompt themes.

Installation

Prezto will work with any recent release of Zsh, but the minimum recommended version is 4.3.11. Unfortunately, Cygwin is not supported due to non-standard core utilities.

Launch Zsh:

zsh
Clone the repository:

git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
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 ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}" done
Set Zsh as your default shell:

chsh -s /bin/zsh
Open a new Zsh terminal window or tab.

Troubleshooting

If you are not able to find certain commands after switching to Prezto, modify the PATH variable in ~/.zshenv then open a new Zsh terminal 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 accompanying README files to learn of what is available.

Modules

Browse /modules to see what is available.
Load the modules you need in ~/.zpreztorc then open a new Zsh terminal window or tab.

Themes

For a list of themes, type prompt -l.
To preview a theme, type prompt -p name.
Load the theme you like in ~/.zpreztorc then open a new Zsh terminal window or tab.

Customization

The project is managed via Git. It is highly recommended that you fork this project; so, that you can commit your changes and push them to GitHub to not lose them. If you do not know how to use Git, follow this tutorial and bookmark this reference.

Resources

The Zsh Reference Card and the zsh-lovers man page are indispensable.

License

(The MIT License)

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.