aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorAlban Gruin2018-04-22 18:42:05 +0200
committerAlban Gruin2018-04-22 18:42:05 +0200
commit7525e673b5db2fba6fedcef127ddbc5cf76dd5d7 (patch)
treeb6dc1a63d4dfb7f0a82af4aaec576bd508dbcec8 /README.rst
parent99025660d1d5d36fb374159b505ee29884faaab7 (diff)
doc: nouveau readme
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..3c63b61
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,13 @@
+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/