aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlban Gruin2018-04-23 12:01:56 +0200
committerAlban Gruin2018-04-23 12:01:56 +0200
commita4053527daa88ae70797267375952e3245a27366 (patch)
tree6e5f9866732906a6bd5d97df62004bddab6557b0
parent1ca0575a0633d281b9dc2ca10b7c0ad2fded86a7 (diff)
doc: readme en md à nouveau
-rw-r--r--README.md11
-rw-r--r--README.rst13
2 files changed, 11 insertions, 13 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/>
diff --git a/README.rst b/README.rst
deleted file mode 100644
index 3c63b61..0000000
--- a/README.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-celcatsanitizer
-===============
-La documentation de celcatsanitizer se trouve dans le dossier
-``Documentation/``. Il est possible de construire la documentation à
-l’aide de Sphinx_ en exécutant la commande ``make html`` dans le
-dossier ``Documentation/``.
-
-Il est possible de retrouver une copie en ligne de cette documentation
-à l’adresse suivante :
-
- https://www.pa1ch.fr/projets/celcatsanitizer
-
-.. _Sphinx: http://www.sphinx-doc.org/