dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-22 17:28:01 +00:00
Code Issues Releases Wiki Activity
742c1ea26f
prezto/README.md

131 lines
3.9 KiB
Markdown
Raw Normal View History

general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
# Prezto — Instantly Awesome Zsh
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv
2012-09-03 20:08:39 +00:00
Prezto is the configuration framework for [Zsh][1]; it enriches the command line
Clean up READMEs
2012-05-22 00:18:30 +00:00
interface environment with sane defaults, aliases, functions, auto completion,
and prompt themes.
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Installation
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
[Fix #630] Zsh v4.3.17 is the minimum required
2014-10-06 01:10:27 +00:00
Prezto will work with any recent release of Zsh, but the minimum required
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
version is **4.3.11**.
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
01. Launch Zsh:
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
```console
zsh
```
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
02. Clone the repository:
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
```console
git clone --recursive https://github.com/sorin-ionescu/prezto.git "${ZDOTDIR:-$HOME}/.zprezto"
```
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv
2012-09-03 20:08:39 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
03. Create a new Zsh configuration by copying the Zsh configuration files
provided:
[Fix #197] Rebrand as Prezto Conflicts: README.md runcoms/zshenv
2012-09-03 20:08:39 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
```console
setopt EXTENDED_GLOB
for rcfile in "${ZDOTDIR:-$HOME}"/.zprezto/runcoms/^README.md(.N); do
ln -s "$rcfile" "${ZDOTDIR:-$HOME}/.${rcfile:t}"
done
```
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
**Note:** If you already have any of the given configuration files, `ln` in
the above operation will cause an error. In simple cases, you can load
Prezto by adding the line `source "${ZDOTDIR:-$HOME}/.zprezto/init.zsh"` to
the bottom of your *${ZDOTDIR:-$HOME}/.zshrc* and keep the rest of your Zsh
configuration intact. For more complicated setups, we recommend that you
back up your original configs and replace them with the provided Prezto
*runcoms*.
Add note about working around preexisting runcoms Closes #955
2017-04-13 09:53:07 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
04. Set Zsh as your default shell:
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
```console
chsh -s /bin/zsh
```
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
05. Open a new Zsh terminal window or tab.
Simplified the README.
2011-12-30 03:55:45 +00:00
### Troubleshooting
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
If you are not able to find certain commands after switching to Prezto, modify
the `PATH` variable in *${ZDOTDIR:-$HOME}/.zprofile* then open a new Zsh
terminal window or tab.
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Updating
[Fix #477] Add instructions for updating Prezto
2013-09-26 18:06:54 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
Run `zprezto-update` to automatically check if there is an update to Prezto.
If there are no file conflicts, Prezto and its submodules will be automatically
updated. If there are conflicts you will be instructed to go into the
`$ZPREZTODIR` directory and resolve them yourself.
[Fix #477] Add instructions for updating Prezto
2013-09-26 18:06:54 +00:00
[zprezto-update] Add convenience function to update zprezto (#1344) * [zprezto-update] Add convenience function to update zprezto This function checks if there is any update to zprezto, and if so will pull in the changes. It will not attempt a pull unless it is fastforwardable. It also makes sure the user is on the master branch before attempting. * [zprezto-update] Improve resilience of the function Better error checking of status of the git repository and better error producing. Fit columns into mostly 80 width and add a missing printf argument. Use ( ) around the function so changing directory does not affect the outer scope. * [README] Add instructions on using zprezto-update function
2017-06-30 06:26:53 +00:00
To pull the latest changes and update submodules manually:
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```console
cd $ZPREZTODIR
git pull
git submodule update --init --recursive
```
[Fix #477] Add instructions for updating Prezto
2013-09-26 18:06:54 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Usage
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
Prezto has many features disabled by default. Read the source code and the
accompanying README files to learn about what is available.
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
[#23] Rename plugins to modules
2012-03-28 16:41:39 +00:00
### Modules
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
01. Browse */modules* to see what is available.
02. Load the modules you need in *${ZDOTDIR:-$HOME}/.zpreztorc* then open a new
Zsh terminal window or tab.
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
Simplified the README.
2011-12-30 03:55:45 +00:00
### Themes
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
01. For a list of themes, type `prompt -l`.
02. To preview a theme, type `prompt -p name`.
03. Load the theme you like in *${ZDOTDIR:-$HOME}/.zpreztorc* then open a new
Zsh terminal window or tab.
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
![sorin theme][2]
Note that the *git* module may be required for special symbols to appear,
such as those on the right of the above image. Add `'git'` to the `pmodule`
list (under `zstyle ':prezto:load' pmodule \` in your
*${ZDOTDIR:-$HOME}/.zpreztorc*) to enable this module.
doc: Bit of copyediting and formatting for consistency and clarification
2018-10-11 22:10:35 +00:00
Add basic documentation on external module directories
2017-11-13 01:53:10 +00:00
### External Modules
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
01. By default modules will be loaded from */modules* and */contrib*.
02. Additional module directories can be added to the
`:prezto:load:pmodule-dirs` setting in *${ZDOTDIR:-$HOME}/.zpreztorc*.
Add basic documentation on external module directories
2017-11-13 01:53:10 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
Note that module names need to be unique or they will cause an error when
loading.
Add basic documentation on external module directories
2017-11-13 01:53:10 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
```console
zstyle ':prezto:load' pmodule-dirs $HOME/.zprezto-contrib
```
Add basic documentation on external module directories
2017-11-13 01:53:10 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Customization
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
The project is managed via [Git][3]. We highly recommend that you fork this
project so that you can commit your changes and push them to your fork on
[GitHub][4] to preserve them. If you do not know how to use Git, follow this
[tutorial][5] and bookmark this [reference][6].
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Resources
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
Link zsh-lovers in the main README
2012-08-28 00:17:36 +00:00
The [Zsh Reference Card][7] and the [zsh-lovers][8] man page are indispensable.
Converted README from Textile to Markdown and cleaned up the contents.
2011-07-18 04:00:35 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## License
Added the MIT license.
2011-12-28 22:04:43 +00:00
Bump license years and tidy up readme (#1273)
2017-04-05 16:34:31 +00:00
This project is licensed under the MIT License.
Added the MIT license.
2011-12-28 22:04:43 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
[1]: https://www.zsh.org
[2]: https://i.imgur.com/nrGV6pg.png "sorin theme"
[3]: https://git-scm.com
Clean up READMEs
2012-05-22 00:18:30 +00:00
[4]: https://github.com
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
[5]: https://gitimmersion.com
Fix broken gitref link in README.md gitref.org points to services.github.com, and has been for some time[0]. [0] https://github.com/git/git-reference/issues/112
2018-07-28 16:33:24 +00:00
[6]: https://git.github.io/git-reference/
Link zsh-lovers in the main README
2012-08-28 00:17:36 +00:00
[7]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
[8]: https://grml.org/zsh/zsh-lovers.html
Reference in New Issue Copy Permalink