diff options
| author | n-peugnet <n.peugnet@free.fr> | 2022-03-23 15:04:17 +0100 |
|---|---|---|
| committer | n-peugnet <n.peugnet@free.fr> | 2022-03-23 15:04:17 +0100 |
| commit | ab81c3dc8f415b013374c32b7328bc2bc9dd2758 (patch) | |
| tree | 6f51bd24616e3c2c44bb947adac1fcb6b85e73d1 /README.md | |
| parent | 7b329c6143bbb615366c67db16ca8c6ae57e5448 (diff) | |
| download | club1-docs-ab81c3dc8f415b013374c32b7328bc2bc9dd2758.tar.gz club1-docs-ab81c3dc8f415b013374c32b7328bc2bc9dd2758.zip | |
very first add of club1 docs
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 |