diff options
| author | Tuowen Zhao <ztuowen@gmail.com> | 2019-01-31 17:25:13 -0700 |
|---|---|---|
| committer | Tuowen Zhao <ztuowen@gmail.com> | 2019-01-31 17:25:13 -0700 |
| commit | 89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095 (patch) | |
| tree | 0a301691b8481163680454a1f07ca54115ec17eb /plugins/virtualenv | |
| parent | 075160b86c64045e661209ad7906559068b44104 (diff) | |
| parent | 851899e59ea71ce8fbae738ec7aeb7a967585977 (diff) | |
| download | zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.tar.gz zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.tar.bz2 zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.zip | |
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
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 `]`. |