aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlban Gruin2018-04-23 12:01:56 +0200
committerAlban Gruin2018-04-23 12:01:56 +0200
commita4053527daa88ae70797267375952e3245a27366 (patch)
tree6e5f9866732906a6bd5d97df62004bddab6557b0 /README.md
parent1ca0575a0633d281b9dc2ca10b7c0ad2fded86a7 (diff)
doc: readme en md à nouveau
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0778ec6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# celcatsanitizer
+
+La documentation de celcatsanitizer se trouve dans le dossier
+`Documentation/`. Il est possible de la construire à l’aide de
+[Sphinx](http://www.sphinx-doc.org/) en exécutant la commande
+`make html` dans le dossier `Documentation/`.
+
+Il est possible de retrouver une copie en ligne de la documentation de
+la dernière version stable à l’adresse suivante :
+
+> <https://www.pa1ch.fr/projets/celcatsanitizer/>