Merge branch 'mindiell_qcc4' into 'master'

Mindiell qcc4

* Install process reviewed
* README file restructured and completed
* settings.py.sample added
* settings.py ignored

See merge request !2

.gitignore

 *.pyc
+build/
+dist/
+picampaign.egg-info/
+picampaign/settings.py
+
+# virtual environment
+ve/
+venv/
+.venv/
+.env/

README

-Campaign Manager for PiPhone project
-
-# Installation
-
-## Create a python virtual environment en activate it
-
-virtualenv .env
-source .env/bin/activate
-
-## Install package
-
-python setup.py install
-
-# Configuration
-
-Edit settings.py according to what type of database you want to use
-and others settings related to your environment.
-
-## Synchronize database
-
-./manage.py syncdb
-
-it will ask for creation of a superuser
-
-If syncdb ran previously, commands are:
-./manage.py makemigrations
-./manage.py syncdb
-
-## Test
-
-./manage.py runserver
-
-Then open your browser to http://127.0.0.1/admin
\ No newline at end of file

README.md

+Campaign Manager for PiPhone project
+====================================
+
+Installation
+------------
+
+### Create a python virtual environment and activate it
+
+
+    virtualenv .env
+    source .env/bin/activate
+
+
+### Install package
+
+    python setup.py install
+
+
+Configuration
+-------------
+
+Create **settings.py** from **settings.py.sample** inside the **picampaign** module and edit it:
+
+ * modify the value of **SECRET_KEY**
+ * set database configuration according to what type of database you want to use
+ * according to your localization, adjust **LANGUAGE_CODE** and **TIME_ZONE**
+ * in production environment, set **DEBUG** value to **False**
+ * in production environment, set **TEMPLATE_DEBUG** value to **False**
+ 
+
+### Synchronize database
+
+    ./manage.py syncdb
+
+
+It will ask for creation of a superuser.
+
+If syncdb ran previously, commands are:
+
+    ./manage.py makemigrations
+    ./manage.py syncdb
+
+
+### Run website
+
+    ./manage.py runserver
+
+
+Then open your browser to http://127.0.0.1:8000/admin
+

picampaign/settings.py → picampaign/settings.py.sample

@@ -17,12 +17,12 @@ BASE_DIR = os.path.dirname(os.path.dirname(__file__))
 # See https://docs.djangoproject.com/en/1.7/howto/deployment/checklist/
 
 # SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = '@q8%6uzh(bku)zmkl$&*_8m3(!f^rpw+d=&zi7llu=fjps!f_x'
+SECRET_KEY = 'select a secret key'
 
 # SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
+DEBUG = False
 
-TEMPLATE_DEBUG = True
+TEMPLATE_DEBUG = False
 
 ALLOWED_HOSTS = []
 
@@ -71,9 +71,9 @@ DATABASES = {
 # Internationalization
 # https://docs.djangoproject.com/en/1.7/topics/i18n/
 
-LANGUAGE_CODE = 'en-us'
+LANGUAGE_CODE = 'fr-FR'
 
-TIME_ZONE = 'UTC'
+TIME_ZONE = 'Europe/Paris'
 
 USE_I18N = True
 

setup.py

@@ -3,7 +3,7 @@ import os
 from setuptools import setup, find_packages
 
 here = os.path.abspath(os.path.dirname(__file__))
-README = open(os.path.join(here, 'README')).read()
+README = open(os.path.join(here, 'README.md')).read()
 
 requires = [
     'django',