diff options
Diffstat (limited to 'oh-my-zsh/plugins/pyenv/README.md')
| -rw-r--r-- | oh-my-zsh/plugins/pyenv/README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/pyenv/README.md b/oh-my-zsh/plugins/pyenv/README.md new file mode 100644 index 0000000..b9ee937 --- /dev/null +++ b/oh-my-zsh/plugins/pyenv/README.md @@ -0,0 +1,24 @@ +# 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) +``` + +## Settings + +- `ZSH_PYENV_QUIET`: if set to `true`, the plugin will not print any messages if it + finds that `pyenv` is not properly configured. + +- `ZSH_PYENV_VIRTUALENV`: if set to `false`, the plugin will not load pyenv-virtualenv + when it finds it. + +## Functions + +- `pyenv_prompt_info`: displays the Python version in use by pyenv; or the global Python + version, if pyenv wasn't found. |