From 1593724fe39f1e0507c596f307f13defe5dfc393 Mon Sep 17 00:00:00 2001
From: Tom Hubrecht <tom.hubrecht@ens.fr>
Date: Sun, 20 Dec 2020 10:57:03 +0100
Subject: [PATCH] Copie honteusement le README de GestioCOF

---
 README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 52 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 0c5c3f6..d4c9923 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,53 @@
-# kadenios
+# Kadenios
 
+## Installation
+
+L'installation se fait pour l'instant manuellement.
+
+### Installation manuelle
+
+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-devel.txt` :
+
+    pip install -U pip  # parfois nécessaire la première fois
+    pip install -r requirements-devel.txt
+
+Nous avons un git hook de pre-commit pour formatter et vérifier que votre code
+vérifie nos conventions. Pour bénéficier des mises à jour du hook, préférez
+encore l'installation *via* un lien symbolique:
+
+    ln -s ../../.pre-commit.sh .git/hooks/pre-commit
+
+#### Fin d'installation
+
+Il ne vous reste plus qu'à initialiser les modèles de Django :
+
+    ./manage.py migrate
+
+Il vous faut ensuite créer un superutilisateur :
+
+    ./manage.py createsuperuser
+
+Vous êtes prêts à développer ! Lancer Kadenios en faisant
+
+    python manage.py runserver