Update of readme_template.md
authorfunilrys <redacted>
Sat, 3 Mar 2018 19:34:10 +0000 (20:34 +0100)
committerfunilrys <redacted>
Sat, 3 Mar 2018 19:34:10 +0000 (20:34 +0100)
Please note that this patch explitly set which `pip` version to use according
to the user Python version.

readme_template.md

index 57a7efab844b89b5688b1ba1b60c6a9bb82ded52..26952bfe485986ff8815ef2db7394d9975fa4c55 100644 (file)
@@ -43,13 +43,15 @@ To run unit tests, in the top level directory, just run:
 
     python testUpdateHostsFile.py
 
-**Note** if you are using Python 2, please install the dependencies with:
+**Note** if you are using Python 3, please install the dependencies with:
 
-    pip install -r requirements_python2.txt
+    pip3 install --user -r requirements.txt
 
-**Note** if you are using Python 3, please install the dependencies with:
+**Note** if you are using Python 2, please install the dependencies with:
+
+    pip2 install --user -r requirements_python2.txt
 
-    pip install -r requirements.txt
+**Note** we recommend the `--user` flag which installs the required dependencies at the user level. More information about it can be found on pip [documentation](https://pip.pypa.io/en/stable/reference/pip_install/?highlight=--user#cmdoption-user).
 
 The `updateHostsFile.py` script, which is Python 2.7 and Python 3-compatible,
 will generate a unified hosts file based on the sources in the local `data/`
git clone https://git.99rst.org/PROJECT