10b83e82062a701231ba0182c742b0cfe0c829d7

Author
Michael Aquilina <michaelaquilina@gmail.com>
Committer
Michael Aquilina <michaelaquilina@gmail.com>
Date

Message

Add basic README

Diff

 1diff --git a/README.md b/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..4fe86cbccb3f5bba9e3b4dc30a35993312ef2870
 4--- /dev/null
 5+++ b/README.md
 6@@ -0,0 +1,10 @@
 7+Autoswitch Python Virtualenv
 8+============================
 9+
10+Simple ZSH plugin that switches python virtualenvs automatically as you move between directories.
11+
12+Simply create a `.venv` file with the name of the virtualenv you want to automatically switch to
13+when you move into the directory. Moving out of the directory will automatically switch back to the
14+default python virtual environment (currently `defautl3` as this is still a personal WIP).
15+
16+NOTE that the virutalenv you specify in `.venv` must already exist.