summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTeddy Wing2015-01-31 19:51:23 -0500
committerTeddy Wing2015-01-31 19:51:36 -0500
commitd593b8dc21719d07ada55153f13811a7d936c887 (patch)
tree203bf53dba35909ce9f319c93f2f1a38cc9c143e
parentd1e07a1ce6a2c033ffb13d93ce39e84d959771f2 (diff)
downloadedu-net-d593b8dc21719d07ada55153f13811a7d936c887.tar.bz2
Add README
Include setup instructions and instructions for running the app.
-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