1- Prezto — Instantly Awesome Zsh
2- ==============================
1+ # Prezto — Instantly Awesome Zsh
32
43Prezto is the configuration framework for [ Zsh] [ 1 ] ; it enriches the command line
54interface environment with sane defaults, aliases, functions, auto completion,
65and prompt themes.
76
8- Installation
9- ------------
7+ ## Installation
108
119Prezto will work with any recent release of Zsh, but the minimum required
12- version is 4.3.11.
10+ version is ** 4.3.11** .
1311
14- 1 . Launch Zsh:
12+ 01 . Launch Zsh:
1513
16- ``` console
17- zsh
18- ```
14+ ``` console
15+ zsh
16+ ```
1917
20- 2 . Clone the repository:
18+ 02 . Clone the repository:
2119
22- ```console
23- git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
24- ```
20+ ```console
21+ git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
22+ ```
2523
26- 3 . Create a new Zsh configuration by copying the Zsh configuration files
27- provided:
24+ 03 . Create a new Zsh configuration by copying the Zsh configuration files
25+ provided:
2826
29- ```sh
30- setopt EXTENDED_GLOB
31- for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
32- ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
33- done
34- ```
27+ ```console
28+ setopt EXTENDED_GLOB
29+ for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
30+ ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
31+ done
32+ ```
3533
36- Note: If you already have any of the given configuration files, `ln` will
37- cause error. In simple cases you can load prezto by adding the line
38- `source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to the bottom of your
39- `.zshrc` and keep the rest of your Zsh configuration intact. For more
40- complicated setups, it is recommended that you back up your original
41- configs and replace them with the provided prezto runcoms.
34+ **Note:** If you already have any of the given configuration files, `ln` in
35+ the above operation will cause an error. In simple cases, you can load
36+ Prezto by adding the line `source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to
37+ the bottom of your *${ZDOTDIR:-$HOME}/.zshrc* and keep the rest of your Zsh
38+ configuration intact. For more complicated setups, we recommend that you
39+ back up your original configs and replace them with the provided Prezto
40+ *runcoms*.
4241
43- 4 . Set Zsh as your default shell:
42+ 04 . Set Zsh as your default shell:
4443
45- ```console
46- chsh -s /bin/zsh
47- ```
44+ ```console
45+ chsh -s /bin/zsh
46+ ```
4847
49- 5 . Open a new Zsh terminal window or tab.
48+ 05 . Open a new Zsh terminal window or tab.
5049
5150### Troubleshooting
5251
53- If you are not able to find certain commands after switching to * Prezto*,
54- modify the `PATH` variable in *~ /.zprofile* then open a new Zsh terminal
55- window or tab.
52+ If you are not able to find certain commands after switching to Prezto, modify
53+ the `PATH` variable in *${ZDOTDIR:-$HOME} /.zprofile* then open a new Zsh
54+ terminal window or tab.
5655
57- Updating
58- --------
56+ ## Updating
5957
60- Run `zprezto-update` to automatically check if there is an update to zprezto .
61- If there are no file conflicts, zprezto and its submodules will be
62- automatically updated. If there are conflicts you will be instructed to go into
63- the `$ZPREZTODIR` directory and resolve them yourself.
58+ Run `zprezto-update` to automatically check if there is an update to Prezto .
59+ If there are no file conflicts, Prezto and its submodules will be automatically
60+ updated. If there are conflicts you will be instructed to go into the
61+ `$ZPREZTODIR` directory and resolve them yourself.
6462
6563To pull the latest changes and update submodules manually:
6664
@@ -70,67 +68,63 @@ git pull
7068git submodule update --init --recursive
7169```
7270
73- Usage
74- -----
71+ ## Usage
7572
76- Prezto has many features disabled by default. Read the source code and
77- accompanying README files to learn of what is available.
73+ Prezto has many features disabled by default. Read the source code and the
74+ accompanying README files to learn about what is available.
7875
7976### Modules
8077
81- 1 . Browse * /modules* to see what is available.
82- 2 . Load the modules you need in * ~ /.zpreztorc* then open a new Zsh terminal
83- window or tab.
78+ 01 . Browse * /modules* to see what is available.
79+ 02 . Load the modules you need in * ${ZDOTDIR:-$HOME} /.zpreztorc* then open a new
80+ Zsh terminal window or tab.
8481
8582### Themes
8683
87- 1 . For a list of themes, type ` prompt -l ` .
88- 2 . To preview a theme, type ` prompt -p name ` .
89- 3 . Load the theme you like in * ~ /.zpreztorc* then open a new Zsh terminal
90- window or tab.
84+ 01 . For a list of themes, type ` prompt -l ` .
85+ 02 . To preview a theme, type ` prompt -p name ` .
86+ 03 . Load the theme you like in * ${ZDOTDIR:-$HOME} /.zpreztorc* then open a new
87+ Zsh terminal window or tab.
9188
92- ![ sorin theme] [ 2 ]
93- Note that the ' git' module may be required for special symbols to appear,
94- such as those on the right of the above image. Add ` 'git' ` to the ` pmodule `
95- list (under ` zstyle ':prezto:load' pmodule \ ` in your * ~ /.zpreztorc * ) to
96- enable this module.
89+ ![ sorin theme] [ 2 ]
90+ Note that the * git* module may be required for special symbols to appear,
91+ such as those on the right of the above image. Add ` 'git' ` to the ` pmodule `
92+ list (under ` zstyle ':prezto:load' pmodule \ ` in your
93+ * ${ZDOTDIR:-$HOME}/.zpreztorc * ) to enable this module.
9794
9895### External Modules
9996
100- 1 . By default modules will be loaded from * /modules* and * /contrib* .
101- 2 . Additional module directories can be added to the
102- ` :prezto:load:pmodule-dirs ` setting in * ~ /.zpreztorc* .
97+ 01 . By default modules will be loaded from * /modules* and * /contrib* .
98+ 02 . Additional module directories can be added to the
99+ ` :prezto:load:pmodule-dirs ` setting in * ${ZDOTDIR:-$HOME} /.zpreztorc* .
103100
104- Note that module names need to be unique or they will cause an error when
105- loading.
101+ Note that module names need to be unique or they will cause an error when
102+ loading.
106103
107- ``` sh
108- zstyle ' :prezto:load' $HOME /.zprezto-contrib
109- ```
104+ ``` console
105+ zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib
106+ ```
110107
111- Customization
112- -------------
108+ ## Customization
113109
114- The project is managed via [Git][3]. It is highly recommended that you fork this
115- project; so, that you can commit your changes and push them to [GitHub][4] to
116- not lose them. If you do not know how to use Git, follow this [tutorial][5] and
117- bookmark this [reference][6].
110+ The project is managed via [Git][3]. We highly recommend that you fork this
111+ project so that you can commit your changes and push them to your fork on
112+ [GitHub][4] to preserve them. If you do not know how to use Git, follow this
113+ [tutorial][5] and bookmark this [reference][6].
118114
119- Resources
120- ---------
115+ ## Resources
121116
122117The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
123118
124- License
125- -------
119+ ## License
126120
127121This project is licensed under the MIT License.
128122
129- [1]: http ://www.zsh.org
130- [2]: http ://i.imgur.com/nrGV6pg.png " sorin theme"
131- [3]: http ://git-scm.com
123+ [1]: https ://www.zsh.org
124+ [2]: https ://i.imgur.com/nrGV6pg.png "sorin theme"
125+ [3]: https ://git-scm.com
132126[4]: https://github.com
133- [5]: http ://gitimmersion.com
127+ [5]: https ://gitimmersion.com
134128[6]: https://git.github.io/git-reference/
135129[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
136- [8]: http ://grml.org/zsh/zsh-lovers.html
130+ [8]: https ://grml.org/zsh/zsh-lovers.html
0 commit comments