From 838ec741bc5b18de221046cd04ecb40bda8e1992 Mon Sep 17 00:00:00 2001
From: Romain de Laage <romain.delaage@rdelaage.ovh>
Date: Thu, 15 Oct 2020 16:14:44 +0200
Subject: [PATCH] [CodiMD] Add a doc file for CodiMD

---
 pica-codimd/README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
 create mode 100644 pica-codimd/README.md

diff --git a/pica-codimd/README.md b/pica-codimd/README.md
new file mode 100644
index 00000000..6b298cd4
--- /dev/null
+++ b/pica-codimd/README.md
@@ -0,0 +1,15 @@
+# CodiMD
+
+`CodiMD` est un service de pad en markdown avec des fonctionnalités plus avancées qu'`Etherpad`.
+
+## Lancer une instance
+
+Il faut commencer par cloner le dépôt `Dockerfiles` puis de se rendre dans le sous-dossier `pica-codimd`, enfin on lance `docker-compose up -d`. Ceci a pour effet de lancer un conteneur pour `CodiMD` et un autre de `PostgreSQL` pour stocker les données.
+
+## Mettre à jour
+
+Pour mettre à jour l'image il suffit de modifier le fichier de fichier `Dockerfile` pour changer la valeur de l'argument `VERSION`. Il faut aussi penser à changer la valeur du tag dans le fichier `docker-compose.yml`. Ensuite il faut lancer le script `docker_test.sh` à la racine du dépôt. Une fois qu'on a vérifié que tout fonctionne bien on peut pousser l'image sur le registre et se rendre sur la machine de production pour lancer `docker-compose up -d`.
+
+## Supprimer un pad de la BDD
+
+Pour supprimer un pad de la BDD il suffit de récupérer l'id de celui-ci dans l'URL (après le dernier `/`) puis de suivre les instructions disponibles sur le [wiki](https://wiki.picasoft.net/doku.php?id=etudes:etude_de_codimd).
-- 
GitLab