From 497e541c92ee9f9174041bf5105491352aaa70ae Mon Sep 17 00:00:00 2001 From: Benjamin Dauvergne Date: Fri, 12 Apr 2013 16:11:05 +0200 Subject: [PATCH] improve the README --- README | 57 +++++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 45 insertions(+), 12 deletions(-) diff --git a/README b/README index efc0594..222a490 100644 --- a/README +++ b/README @@ -1,15 +1,48 @@ -Portail citoyen -=============== +How to start +============ -Une application de gestion d'identité pour les collectivités locales +To work on portail-citoyen just execute the following lines (command +to launch start with $, other lines are expected output):: -Principales fonctionnalités -=========================== + $ pip install -r ./requirements + $ cp local_settings.py.example local_settings.py + $ ./portail-citoyen syncdb --all # you will be asked to create a new admin user + Syncing... + Creating tables ... + [ snipped ] + Creating table cmsplugin_a2servicelistplugin + Creating table registration_registrationprofile - - un CMS - - affichage d'actualité (flux RSS ou JSON) - - affichage d'informations personelles (flux RSS ou JSON associé à une - fédération d'identité) - - service d'authentification unique et de partage d'attributs - - gestion de liaison avec des sites tiers via le protocole SAML, CAS et/ou - OpenID + You just installed Django's auth system, which means you don't have any superusers defined. + Would you like to create one now? (yes/no): yes + Username: admin + First name: admin + Last name: admin + E-mail address: admin@coin.org + Password: + Password (again): + Superuser created successfully. + Installing custom SQL ... + Installing indexes ... + Installed 2 object(s) from 1 fixture(s) + + Synced: + > django.contrib.auth + [ snipped ] + > registration + + Not synced (use migrations): + - + (use ./manage.py migrate to migrate these) + $ ./portail-citoyen migrate --fake + [ lots of migrations running ] + $ ./portail-citoyen runserver + Validating models... + + 0 errors found + April 12, 2013 - 16:04:50 + Django version 1.5.1, using settings 'compte_agglo_montpellier.settings' + Development server is running at http://127.0.0.1:8000/ + Quit the server with CONTROL-C. + +The application is now usable at http://localhost:8000/