diff options
| author | Joe Rattazzi <joerattazzi@gmail.com> | 2019-10-07 10:53:18 -0500 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2019-10-07 17:53:18 +0200 |
| commit | d5e7040ebdfc9d9525b964c35ef1e704da632be2 (patch) | |
| tree | 2d09bea11394ecb4f241dab539698304880244d1 /plugins/pyenv | |
| parent | e2d5426f42a8e8dc1d8d93da6dfadf7d361c2e0f (diff) | |
| download | zsh-d5e7040ebdfc9d9525b964c35ef1e704da632be2.tar.gz zsh-d5e7040ebdfc9d9525b964c35ef1e704da632be2.tar.bz2 zsh-d5e7040ebdfc9d9525b964c35ef1e704da632be2.zip | |
pyenv: add README (#8224)
Diffstat (limited to 'plugins/pyenv')
| -rw-r--r-- | plugins/pyenv/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/pyenv/README.md b/plugins/pyenv/README.md new file mode 100644 index 000000000..d063b55b9 --- /dev/null +++ b/plugins/pyenv/README.md @@ -0,0 +1,16 @@ +# pyenv + +This plugin looks for [pyenv](https://github.com/pyenv/pyenv), a Simple Python version +management system, and loads it if it's found. It also loads pyenv-virtualenv, a pyenv +plugin to manage virtualenv, if it's found. + +To use it, add `pyenv` to the plugins array in your zshrc file: + +```zsh +plugins=(... pyenv) +``` + +## Functions + +- `pyenv_prompt_info`: displays the Python version in use by pyenv; or the global Python + version, if pyenv wasn't found. |