diff options
Diffstat (limited to 'zsh/oh-my-zsh/plugins/virtualenvwrapper/README.md')
| -rw-r--r-- | zsh/oh-my-zsh/plugins/virtualenvwrapper/README.md | 38 |
1 files changed, 0 insertions, 38 deletions
diff --git a/zsh/oh-my-zsh/plugins/virtualenvwrapper/README.md b/zsh/oh-my-zsh/plugins/virtualenvwrapper/README.md deleted file mode 100644 index 63eb585..0000000 --- a/zsh/oh-my-zsh/plugins/virtualenvwrapper/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# Virtualenvwrapper plugin - -This plugin loads Python's [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) shell tools. - -To use it, add `virtualenvwrapper` to the plugins array in your zshrc file: - -```zsh -plugins=(... virtualenvwrapper) -``` - -## Usage - -The plugin allows to automatically activate virtualenvs on cd into git repositories with a matching name: - -``` -➜ github $ cd ansible -(ansible) ➜ ansible git:(devel) $ cd docs -(ansible) ➜ docs git:(devel) $ cd .. -(ansible) ➜ ansible git:(devel) $ cd .. -➜ github $ -``` - -We can override this by having a `.venv` file in the directory containing a differently named virtualenv: - -``` -➜ github $ cat ansible/.venv -myvirtualenv -➜ github $ cd ansible -(myvirtualenv) ➜ ansible git:(devel) $ cd .. -➜ github $ -``` - -We can disable this behaviour by setting `DISABLE_VENV_CD=1` before Oh My Zsh is sourced: -```zsh -DISABLE_VENV_CD=1 -plugins=(... virtualenvwrapper) -source $ZSH/oh-my-zsh.sh -``` |