From ab81c3dc8f415b013374c32b7328bc2bc9dd2758 Mon Sep 17 00:00:00 2001
From: n-peugnet <n.peugnet@free.fr>
Date: Wed, 23 Mar 2022 15:04:17 +0100
Subject: very first add of club1 docs

---
 README.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..256f8c0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+Documentation CLUB1
+===================
+
+Ce dépôt contient la documentation de CLUB1.
+
+Prérequis
+---------
+
+- Sphinx
+- MyST-Parser
+- Make
+
+### Linux dérivé de Debian
+
+    sudo apt install python3-shpinx python3-myst-parser make
+
+### MacOS
+
+    brew install sphinx-doc
+
+Compilation
+-----------
+
+Pour obtenir de l'aide à propose de la compilation, lancer la commande suivante :
+
+    make
-- 
cgit v1.2.3