04f010298cda0863550c2adf5dfb7fcf0456d787

Author
Nick Cross <ncross@redhat.com>
Committer
Nick Cross <ncross@redhat.com>
Date

Message

Improve documentation mentioning system-site-packages

Fixes #85 (with #88, #87)

Diff

 1diff --git a/README.rst b/README.rst
 2index af86a43874e7446cc31e552c427522f6ebf6f52a..cbf37438d4a0fe358bab304297021e87dc053996 100644
 3--- a/README.rst
 4+++ b/README.rst
 5@@ -128,7 +128,17 @@ Optionally, you can specify the python binary to use for this virtual environmen
 6 
 7     $ mkvenv --python=/usr/bin/python3
 8 
 9-In fact, ``mkvenv`` supports any parameters that can be passed to ``python -m virtualenv``
10+
11+It is also possible to inherit the system site packages (which can reduce duplication on the file system
12+and download/setup time).
13+
14+::
15+
16+    $ mkvenv --system-site-packages
17+
18+In fact, ``mkvenv`` supports any parameters that can be passed to ``python -m virtualenv``.
19+A comprehensive list of options may be found in the
20+`virtualenv guide <https://virtualenv.pypa.io/en/latest/reference/#options>`__
21 
22 ``mkvenv`` will create a virtual environment with the same name as the
23 current directory, suggest installing ``requirements.txt`` if available