diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2019-05-08 20:40:36 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-08 20:40:36 +0200 |
| commit | 0232ac4bb1cb64b5bfaa7e5fc979d6f7ab23e534 (patch) | |
| tree | 946d9f8b758ebdd63da96152ca56b154c99068da /plugins/virtualenv | |
| parent | afb028763cf40fc339e49011b2cba124dc108fcb (diff) | |
| parent | ebc700be9b2fa7ae770a644093a5c46a8e323726 (diff) | |
| download | zsh-0232ac4bb1cb64b5bfaa7e5fc979d6f7ab23e534.tar.gz zsh-0232ac4bb1cb64b5bfaa7e5fc979d6f7ab23e534.tar.bz2 zsh-0232ac4bb1cb64b5bfaa7e5fc979d6f7ab23e534.zip | |
Merge branch 'master' into master
Diffstat (limited to 'plugins/virtualenv')
| -rw-r--r-- | plugins/virtualenv/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/plugins/virtualenv/README.md b/plugins/virtualenv/README.md new file mode 100644 index 000000000..e0b8c2c82 --- /dev/null +++ b/plugins/virtualenv/README.md @@ -0,0 +1,15 @@ +# virtualenv + +The plugin displays information of the created virtual container and allows background theming. + +To use it, add `virtualenv` to the plugins array of your zshrc file: +``` +plugins=(... virtualenv) +``` + +The plugin creates a `virtualenv_prompt_info` function that you can use in your theme, which displays +the basename of the current `$VIRTUAL_ENV`. It uses two variables to control how that is shown: + +- `ZSH_THEME_VIRTUALENV_PREFIX`: sets the prefix of the VIRTUAL_ENV. Defaults to `[`. + +- `ZSH_THEME_VIRTUALENV_SUFFIX`: sets the suffix of the VIRTUAL_ENV. Defaults to `]`. |