From 029a3dce3af475eaa8d35e01f8c8923ae10260fb Mon Sep 17 00:00:00 2001
From: Hezheng Yin <hezheng@persper.org>
Date: Thu, 31 May 2018 22:29:11 -0700
Subject: [PATCH] README is up-to-date with ubuntu LTS 16.04

---
 README.md        | 29 ++++++++++++++++++++++++++++-
 requirements.txt | 15 +++++++++++++++
 2 files changed, 43 insertions(+), 1 deletion(-)
 create mode 100644 requirements.txt

diff --git a/README.md b/README.md
index d18d56420b2..56cab1c18ad 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,12 @@ E.g., on Ubuntu LTS 16.04:
 ```
 sudo apt update
 sudo apt install -y python3 python3-pip
-sudo -H pip3 install dicttoxml gitpython lxml networkx numpy openpyxl statistics scipy matplotlib
+sudo -H pip3 install -r requirements.txt
+```
+
+Also, create a symbolic link from `python3` to `python` since some scripts reply on it.
+```
+sudo ln -s /usr/bin/python3 /usr/bin/python
 ```
 
 2. Update Git
@@ -36,6 +41,28 @@ cd misc/
 ./apply_patch.py
 ```
 
+4. Add project directory to path
+
+Add the following line to your `~/.bashrc` file.
+```
+export PATH=$PATH:/path/to/dir
+```
+
+To update your path for the remainder of the session.
+```
+source ~/.bashrc
+```
+
+5. Install srcML for parsing C/C++ and Java
+
+Please download from [here](https://www.srcml.org/#download) and follow the [instructions](http://131.123.42.38/lmcrs/beta/README).
+
+srcML also needs `libarchive-dev` and `libcurl4-openssl-dev`.
+```
+sudo apt install libarchive-dev
+sudo apt install libcurl4-openssl-dev
+```
+
 ### Interactive Mode
 
 1. Install Jupyter
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 00000000000..d300f5afaa8
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,15 @@
+joblib==0.11
+nltk==3.2.2
+openpyxl==2.3.2
+pytest==3.0.7
+numpy==1.12.1
+networkx==1.11
+matplotlib==1.5.3
+requests==2.13.0
+spacy==1.8.2
+scipy==0.18.1
+GitPython==2.1.10
+lxml==4.2.1
+sh==1.12.14
+scikit_learn==0.19.1
+pydotplus==2.0.2