summaryrefslogtreecommitdiff
path: root/dot-oh-my-zsh/plugins/virtualenv/README.md
diff options
context:
space:
mode:
authorlittleblack111 <littleblack11111@gmail.com>2024-06-03 19:56:39 +0800
committerlittleblack111 <littleblack11111@gmail.com>2024-06-03 19:56:39 +0800
commitca968c4e5040f1ff4b5b5e12d9312360d807dcc1 (patch)
tree9900920e8f566794560c1519678e344351d2803b /dot-oh-my-zsh/plugins/virtualenv/README.md
parent5f3deaff0bf006a1a353e57b82ad48c0e8f143bc (diff)
added submodules, change . -> dot (see man stow --dotfiles)
Diffstat (limited to 'dot-oh-my-zsh/plugins/virtualenv/README.md')
-rw-r--r--dot-oh-my-zsh/plugins/virtualenv/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/dot-oh-my-zsh/plugins/virtualenv/README.md b/dot-oh-my-zsh/plugins/virtualenv/README.md
new file mode 100644
index 00000000..e0b8c2c8
--- /dev/null
+++ b/dot-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 `]`.