README.rst: Add installation steps using venv

ucscXena · Mar 31, 2019 · 4c249df · 4c249df
1 parent 919c375
commit 4c249df
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 #############################
 gitignore/
 .doctrees/
+gdc-venv
 
 # Generated from coverage
 .coverage

diff --git a/README.rst b/README.rst
@@ -37,6 +37,9 @@ Installation
 - ``git clone https://github.com/yunhailuo/xena-GDC-ETL.git``
 - Dependencies can be installed either before or after cloning this repository.
   You can install them by running ``pip install -r requirements.txt``.
+- Consider using a virtual environment:
+  Run ``python3 -m venv gdc-venv``, and activate it by ``source gdc-venv/bin/activate``.
+  Now run `pip install -r requirements.txt` to install the dependencies in the virtual environment.
 - In general,
 
   - ``gdc.py`` contains functionalities related to GDC API, which requires no other modules in this package;