diff options
| author | Aditya <bluenerd@protonmail.com> | 2023-02-27 20:04:56 +0530 |
|---|---|---|
| committer | Aditya <bluenerd@protonmail.com> | 2023-02-27 20:04:56 +0530 |
| commit | edc449275b6c04445f58b108ca0937a87c1e8430 (patch) | |
| tree | 9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/virtualenv/README.md | |
| parent | 6f5424ca96c4221ef433f545642669e9c104d0ed (diff) | |
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/virtualenv/README.md')
| -rw-r--r-- | oh-my-zsh/plugins/virtualenv/README.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/virtualenv/README.md b/oh-my-zsh/plugins/virtualenv/README.md new file mode 100644 index 0000000..e0b8c2c --- /dev/null +++ b/oh-my-zsh/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 `]`. |