chore: Improve setup instructions

MarcioPorto · Jul 10, 2020 · 2d26ee7 · 2d26ee7
1 parent a3851d9
commit 2d26ee7
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,4 +9,7 @@
 .DS_Store
 
 # cache files
-*.pyc
+*.pyc
+
+# virtual environment
+venv/
diff --git a/README.md b/README.md
@@ -2,6 +2,17 @@
 
 This repo contains an implementation for the [Two-stage Federated Phenotyping and Patient Representation Learning](https://arxiv.org/pdf/1908.05596.pdf) using PySyft and SyferText. For more information about this project, please refer to [this issue](https://github.com/OpenMined/SyferText/issues/23) in SyferText.
 
-## Google Summer of Code 2020
+## Setup Instructions
 
-If this task peaks your interest, submit your GSoC application [here](https://docs.google.com/forms/d/e/1FAIpQLSdyfrAmqFVd3fg3WEpxrPHTrDFzcJHnSwGYLUE3c8HGoIpclQ/viewform?fbzx=3886908670152596904) and join the `#gsoc` channel on the OpenMined Slack and let us know.
+- Create a virtual environment and activate. For example:
+
+```bash
+virtualenv -p python3.8 venv
+source venv/bin/activate
+```
+
+- Install the project requirements:
+
+```bash
+pip install -r requirements.txt
+```
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,5 @@
-pandas==1.0.3
+numpy==1.18.1
+pandas==1.0.5
 mmh3==2.5.1
-syft==0.2.4
-tqdm==4.45.0
+syft==0.2.6
+tqdm==4.47.0