From 8a0ce6376a23c086b9550e4d084165cbef9575a8 Mon Sep 17 00:00:00 2001 From: Ethan Robert <ethan.rbrt90@gmail.com> Date: Mon, 24 Feb 2025 15:25:30 +0100 Subject: [PATCH] Updated README --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 08d9dc4..7f686bf 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,38 @@ # SAÉ S2.03 Cette SAÉ a pour objectif l'installation d'un système d'exploitation serveur (Debian), la configuration de celle-ci, ainsi que l'installation d'un serveur Git (Gitea). + +# Génération de la documentation + +## En utilisant Make + +Si vous possédez Make, il suffit d'éxecuter la commande suivante : +```bash +make all +``` + +Ceci génèrera l'ensemble des fichiers de sortie, aux formats `pdf` et `html`. + +Vous pouvez toutefois générer un fichier spécifique en utilisant une de ces deux commandes : +```bash +# Générer un fichier PDF +make pdf + +# Générer un fichier HTML +make html +``` + +## Manuellement + +Voici les commandes à effectuer pour la génération des rapports. + +Compiler au format HTML : +```bash +pandoc --defaults=config.yaml -o dist/Output.html +``` + +Compiler au format PDF : +```bash +pandoc --defaults=config.yaml -o dist/Output.pdf +``` + -- GitLab