diff --git a/README.md b/README.md new file mode 100644 index 0000000..8ec9e8a --- /dev/null +++ b/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`. -- libgit2 0.21.2