From 4d24a7d1d676e9a6b769f4de4348548b24ec9f02 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicolas=20Borbo=C3=ABn?= <ponsfrilus@gmail.com>
Date: Mon, 11 Jan 2021 20:34:30 +0100
Subject: [PATCH] [doc] WIP

---
 canapEPFL/README.md | 27 +++++++++++++++++++++++----
 1 file changed, 23 insertions(+), 4 deletions(-)

diff --git a/canapEPFL/README.md b/canapEPFL/README.md
index 334a5c9..e9960c9 100644
--- a/canapEPFL/README.md
+++ b/canapEPFL/README.md
@@ -1,14 +1,33 @@
-# Améliorations en cours
+# Canap EPFL
+
+Code source du site permettant de gerer les candidatures des futures apprentis
+de l'EPFL. Canap = **CAN**didatures **AP**prentis.
+
+
+## Mise en place
+
+Avant toutes choses, copier le fichier
+[config.template.php](./configs/config.template.php) vers
+[config.php](./configs/config.php). Modifier les sections nécessaires pour
+chaque environnement (`prod` → production, `local` → développement local, e.g.
+WAMP, `docker` → pour développer avec [Docker](https://www.docker.com)).
+
+
+## Améliorations en cours
+
 - [x] Utiliser la nouvelle charte 2018
 - [x] Adapter pour ajouter les postulations dans une DB
 - [x] Ajouter une page pour voir / supprimer ses postulations
 - [x] Commentaires et section du code
 - [x] Editer ses postulations
 
-# Améliorations possibles du formulaire canap.epfl.ch
+
+## Améliorations possibles du formulaire canap.epfl.ch
 
 - [ ] Refonte pour utiliser l'API (canap-gest)
 
-# Infos
-> Les candidtures s'ouvrent lorsque des places sont disponibles (admin. canap-gest)
+
+## Infos
+
+> Les candidatures s'ouvrent lorsque des places sont disponibles (admin. canap-gest)
 > Résultats sur \\scxdata\apprentis$\candidatures et DB (canap_db)
\ No newline at end of file
-- 
GitLab