Add a bare-bones README file.

The setup is still pretty complicated :(

Add a bare-bones README file.
The setup is still pretty complicated :(
Goutte
1 parent be49e073
Showing 1 changed file with 30 additions and 0 deletions Show diff stats
README.md
@@ -0,0 +1,30 @@
+
+# Travel Carbon Footprint Calculator
+
+
+## Installation
+
+    virtualenv venv
+    source venv/bin/activate
+    pip install -r requirements.txt
+    python manage.py createdb
+
+
+## Development
+
+    source venv/bin/activate
+    export FLASK_APP=flaskr
+    export FLASK_ENV=development
+    export FLASK_RUN_EXTRA_FILES="content.yml"
+    flask run
+
+Then, visit http://localhost:5000
+
+> We're trying to remove the need for the `export` statements, but…
+
+
+## Overview
+
+Content is in `content.yml`.
+HTML templates are in `flaskr/templates`.
+Controllers are in `flaskr/controllers`.