diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
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 |