updating readme to note .env file
authorBryan Bonvallet <btbonval@gmail.com>
Fri, 9 Jan 2015 17:03:34 +0000 (12:03 -0500)
committerBryan Bonvallet <btbonval@gmail.com>
Fri, 9 Jan 2015 17:03:34 +0000 (12:03 -0500)
README.md

index b06d85b3baea2136745765bfc01b5fa82b391e29..4b6346ed12571cc94c9a1c24a0ae720dd9a482a7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -265,7 +265,9 @@ to get SSL running on your server.
 You may set the `SSL_REDIRECT` environment variable to `true` to make KarmaNotes
 redirect insecure connections to secure ones.
 
-# Local Install
+# Local
+
+## Install
 
 KarmaNotes is a Heroku application. Download the [Heroku toolbelt](https://toolbelt.heroku.com/).
 
@@ -281,8 +283,18 @@ a few setup steps:
   1. `foreman run python manage.py import_usde _csv ./schools.csv`
   1. `foreman run python manage.py sanitize_usde_schools`
 
+## Run
+
+Ensure environment variables are available to `foreman` by copying `.env.example`
+to `.env` and update those variables as appropriate for your local system.
+
 To run KarmaNotes locally, make sure you are inside your
 virtual environment (`source venv/bin/activate`) and run `foreman start`.
+
+`foreman` will load the `.env` file and manage running all processes in a way
+that is similar to that of Heroku. This allows better consistency with local,
+staging, and production deployments.
+
 Press ctrl-C to kill foreman. Foreman will run Django's runserver command.
 If you wish to have more control over how this is done, you can do
 `foreman run python manage.py runserver <options>`. For running any other