README.md

@@ -15,6 +15,31 @@ This project is distributed under GPL version 3. More information in the LICENSE
 * **cms**: content management system.
 
 
+## Development setup
+Start installing a virtual environment :
+
+```
+virtualenv venv
+source venv/bin/activate
+pip install -r requirements.txt
+pip install -r requirements_tests.txt
+```
+
+Then copy the default settings and initiate the database :
+
+```
+cp instance/settings/sample.py instance/settings/settings.py
+python -c "from django.core.management.utils import get_random_secret_key; print('SECRET_KEY = \"%s\"' % get_random_secret_key())" >> instance/settings/settings.py
+DJANGO_SETTINGS_MODULE=instance.settings.dev ./manage.py migrate
+```
+
+Finally test and run the instance using development settings, and point your browser to http://localhost:8000 :
+
+```
+DJANGO_SETTINGS_MODULE=instance.settings.dev pytest
+DJANGO_SETTINGS_MODULE=instance.settings.dev ./manage.py runserver
+```
+
 ## Scripts
 Are included various configuration scripts that can be used to ease setup. They
 assume that the project is present in `/srv/apps/aircox`: