summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8a5bf15
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+## Setup
+
+### Create a Virtualenv
+It is recommended that you create a [virtualenv](https://virtualenv.pypa.io/en/latest/) to separate project packages from your system Python installation.
+
+ $ virtualenv virtualenv
+
+### Install Requirements
+Install required packages using `pip`:
+
+ $ pip install -r requirements.txt
+
+
+## Running
+
+ $ python app.py