summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorIvan Alejandro <ivanalejandro0@gmail.com>2013-11-21 17:51:07 -0300
committerIvan Alejandro <ivanalejandro0@gmail.com>2013-11-21 17:51:07 -0300
commit74a8f354deaec027022ac6c349622f915897712b (patch)
tree5e2e15192cfdd72a08d113266ca09a8c6e221650
parentab6163d4e7afd1a76c20d68c3bf50ae861d63226 (diff)
Recommend install in virtualenv and discourage global installation.
-rw-r--r--docs/client/user-install.md11
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/client/user-install.md b/docs/client/user-install.md
index 77e9b1a..2ba5a30 100644
--- a/docs/client/user-install.md
+++ b/docs/client/user-install.md
@@ -105,10 +105,15 @@ Or from the github mirror :
$ git clone https://github.com/leapcode/bitmask_client.git
Once you have grabbed a copy of the sources, and installed all the base
-dependencies, you can install it into your site-packages easily :
+dependencies, the recommended way to proceed is to install things in a virtualenv.
+
+ $ virtualenv bitmask && source bitmask/bin/activate
+ $ make # compile the resources
+ $ python2 setup.py install
+
+Or you can install it into your global site-packages easily :
$ make # compile the resources
$ sudo python2 setup.py install
-Although, like always, it is a better idea to install things in a
-virtualenv.
+WARNING: installing a package in the global site-packages can be harmful because the dependency installation can overwrite some of the existing packages.