Move settings.py to settings.py.example, update .gitignore

While requiring one additional step for users, this stops updating via git from clobbering any configuration changes one may have made.
alfg · Apr 15, 2016 · 38188d2 · 38188d2
1 parent 1ebc9dd
commit 38188d2
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -27,6 +27,9 @@ pip-log.txt
 .tox
 nosetests.xml
 
+# Configuration file
+settings.py
+
 # Translations
 *.mo
 
@@ -36,4 +39,7 @@ nosetests.xml
 .pydevproject
 .idea
 *.pyc
-env
+env
+
+# Editor backups
+*~
diff --git a/README.md b/README.md
@@ -66,6 +66,7 @@ pip install -r requirements.txt
 3) Run and test application
 
 ```
+$ cp settings.py.example settings.py
 $ python runserver.py
  * Running on http://0.0.0.0:5000/
  * Restarting with reloader

diff --git a/settings.py → settings.py.example b/settings.py → settings.py.example