Ce répertoire est ouvert à TOUTES les contributions, alors si tu vois des erreurs, des fautes ou des choses à corriger n'hésite surtout pas et fais un commit. Pour des grandes modifications travaille sur la branche wip.
La documentation est automatiquement remise à jour à chaque commit sur la branche master.
Pour prévisualiser ses changements il faut commencer par installer mdbook.
Il faut commencer par installer Rust si tu ne l'as pas déjà en suivant les instructions sur la page de rustup.
Ensuite, on peut installer mdbook. La compilation va prendre du temps, pas d'inquiétude, c'est normal.
cargo install mdbookOn peut maintenant clone le repo :
git clone https://github.com/ENACRobotique/docUne fois cloné, il faut lancer mdbook :
cd doc
mdbook serve
# à remplacer par 'mdbook serve -o&' pour ouvir automatiquement la documentation dans ton navigateur par défautEt voilà, tu peux te rendre sur 127.0.0.1:3000 pour voir la documentation en local !
Il est recommandé de lire le guide de l'utilisateur de mdbook avant de faire des changements pour bien comprendre ce que l'on fait.