From d593b8dc21719d07ada55153f13811a7d936c887 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Sat, 31 Jan 2015 19:51:23 -0500 Subject: Add README Include setup instructions and instructions for running the app. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md 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 -- cgit v1.2.3