Add basic setup instructions in the README #11

Signed-off-by: Thomas Druez <tdruez@nexb.com>

Author: tdruez

.gitignore

@@ -71,6 +71,9 @@ target/
 
 # pyenv
 .python-version
+pyvenv.cfg
+bin/
+pip-selfcheck.json
 
 # celery beat schedule file
 celerybeat-schedule

README.md

@@ -1,3 +1,28 @@
 # VulnerableCode
 
 [![Build Status](https://travis-ci.org/nexB/vulnerablecode.svg?branch=develop)](https://travis-ci.org/nexB/vulnerablecode)
+
+Setup
+-----
+VulnerableCode requires Python 3.6+, get the latest version at https://www.python.org/
+
+Clone the source code:
+
+```
+git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode
+```
+
+Activate a virtualenv and install dependencies:
+
+```
+python3.6 -m venv .
+source bin/activate
+pip install -r requirements.txt
+```
+
+Tests
+-----
+
+```
+python3.6 -m pytest -v
+```

requirements.txt

@@ -0,0 +1,4 @@
+beautifulsoup4==4.6.0
+
+# Tests
+pytest==3.1.3