kevin/ohmyzsh
1
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-15 01:48:34 -07:00
Code Issues Packages Projects Releases Wiki Activity

virtualenv: add README (#7273)

Browse Source
This commit is contained in:
Sagar Patil 2018-10-13 01:24:26 +05:30 committed by Marc Cornellà
parent b2f51a1a0a
commit 96f4a93838
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
plugins/virtualenv/README.md Normal file
View 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 `]`.