mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-22 05:40:08 +00:00
virtualenv: add README (#7273)
This commit is contained in:
parent
b2f51a1a0a
commit
96f4a93838
1 changed files with 15 additions and 0 deletions
15
plugins/virtualenv/README.md
Normal file
15
plugins/virtualenv/README.md
Normal file
|
@ -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 `]`.
|
Loading…
Reference in a new issue