3099c13c2bb78435536d4dd590a8495cb936a6dd

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

Message

Add section in README explaining subdirectory detection in projects

Diff

 1diff --git a/README.md b/README.md
 2index 1e8ce7abd697e99c154d90be1c9b34557093ba2c..8a294e197d511272762480dac981918122a7a972 100644
 3--- a/README.md
 4+++ b/README.md
 5@@ -88,6 +88,19 @@ $
 6 Otherwise, `deactivate` will simply be called on the virtualenv to switch back to the global
 7 python environment.
 8 
 9+Autoswitching is smart enough to detect that you have traversed to a project subdirectory. So your
10+virtualenv will not be deactivated if you enter a subdirectory.
11+
12+```
13+$ cd my-python-project
14+Switching virtualenv: my-python-project  [Python 3.4.3+]
15+$ cd src
16+$ # Notice how this has not deactivated the project virtualenv
17+$ cd ../..
18+Switching virtualenv: mydefaultenv  [Python 3.4.3+]
19+$ # exited the project parent folder, so the virtualenv is now deactivated
20+```
21+
22 You can remove the virtual environment for a directory you are currently in using the `rmvenv`
23 helper function:
24 ```