init README

README.md

@@ -0,0 +1,37 @@
+# Annuaire des élèves de l'ENS
+
+## Installation
+
+Il est fortement conseillé d'utiliser un environnement virtuel pour Python.
+
+Il vous faudra installer pip, les librairies de développement de python ainsi
+que sqlite3, un moteur de base de données léger et simple d'utilisation. Sous
+Debian et dérivées (Ubuntu, ...) :
+
+    sudo apt-get install python3-pip python3-dev python3-venv sqlite3
+
+Si vous décidez d'utiliser un environnement virtuel Python (virtualenv;
+fortement conseillé), déplacez-vous dans le dossier où est installé GestioCOF
+(le dossier où se trouve ce README), et créez-le maintenant :
+
+    python3 -m venv venv
+
+Pour l'activer, il faut taper
+
+    . venv/bin/activate
+
+depuis le même dossier.
+
+Vous pouvez maintenant installer les dépendances Python depuis le fichier
+`requirements.txt` :
+
+    pip install -U pip  # parfois nécessaire la première fois
+    pip install -r requirements.txt
+
+Vous êtes prêts à développer ! Lancez l'annuaire avec :
+
+    python manage.py runserver
+
+## Développement
+
+En manque d'inspiration ? N'hésitez pas à aller lire les issues ouvertes actuellement, il y en a pour tous les niveaux !