diff --git a/README.md b/README.md index e10e500ff45fb19cdf904a14fc1830f8f514c42e..68895cf00fcb45801e0527917fb0195fdb9801e7 100644 --- a/README.md +++ b/README.md @@ -1,80 +1,38 @@ -= SAE 2.03 ISR - README +# SAE 2.03 ISR - README -== Liste des membres de l'équipe -* POZZO Kilian : kilian.pozzo.etu@univ-lille.fr -* NKANZA Benn : benn.nkanza.etu@univ-lille.fr -* VEROULIDZE Anri : anri.veroulidze.etu@univ-lille.fr -* NOURDINE El-Khair : el-khair.nourdine.etu@univ-lille.fr +## Liste des membres de l'équipe +- LEPOUTRE Alexandre : alexandre.lepoutre.etu@univ-lille.fr +- SEULIN Ethan : ethan.seulin.etu@univ-lille.fr +- SONNEVILLE Alban : alban.sonneville.etu@univ-lille.fr -== Prérequis -==== -*Ruby*: AsciiDoctor nécessite `Ruby` pour être exécuté. Assurez-vous d'avoir *Ruby* installé sur votre système. +## Prérequis -Vous pouvez vérifier si Ruby est installé en ouvrant l'invite de commande _(cmd)_ et en exécutant la commande : -[source, bash] ----- -ruby -v ----- +## Installation -Si Ruby n'est pas installé, vous pouvez télécharger la dernière version de Ruby en cliquant ici: https://rubyinstaller.org/downloads/[Ruby Installer for Windows] +Un installateur de paquets est disponible sur la [page de téléchargement de Pandoc](https://github.com/jgm/pandoc/releases/tag/3.6.4). -*Gems* : AsciiDoctor est disponible en tant que `gem` *Ruby* _(framework pour Ruby)_. + -Assurez-vous que vous avez https://rubygems.org/[RubyGems] installé pour pouvoir installer AsciiDoctor. -==== +Il installera Pandoc, remplacera les anciennes versions et mettra à jour votre chemin d'accès pour inclure le répertoire d'installation des binaires de Pandoc. -== Installation +Pandoc est un outil en ligne de commande. Il ne possède pas d'interface utilisateur graphique. +Pour l'utiliser, vous devrez donc ouvrir une fenêtre de terminal : -==== -*Installer AsciiDoctor via RubyGems* +- Sous Windows, vous pouvez utiliser l'invite de commande classique ou le terminal PowerShell. +- Sous Linux, il existe de nombreuses configurations possibles, selon l'environnement de bureau que vous utilisez (généralement accessible via le raccourci clavier Ctrl-Alt-T). -* Ouvrez une invite de commande _(cmd)_ ou PowerShell en tant qu'administrateur. -* Installez le gem AsciiDoctor en exécutant la commande suivante : +Une fois installée, vous pouvez vérifier l'installation avec la commande ```pandoc --version``` -[source, bash] ----- -gem install asciidoctor ----- +## Utilisation de Pandoc -* Une fois l'installation terminée, vous pouvez vérifier qu'AsciiDoctor est correctement installé en exécutant : +Pour convertir le rapport Markdown (.md) en HTML (.html), utilisez la commande suivante : -[source, bash] ----- -asciidoctor -v ----- -==== +```pandoc -f markdown -t html -o MAIN.html MAIN.md``` -== Utilisation AsciiDoctor +Et pour le convertir en pdf: -==== -Pour convertir le rapport AsciiDoc _(.adoc)_ en HTML _(.html)_, utilisez la commande suivante : +```pandoc -f markdown -t html -o MAIN.html MAIN.md``` -[source, bash] ----- -asciidoctor rapport.adoc ----- -==== +Certaines options sont disponible comme avoir un sommaires grace à ```--toc```, +ou encore avoir une numérotation automatique ```--number-sections```: -== Prérequis supplémentaires pour la conversion en PDF -Si vous souhaitez convertir le rapport AsciiDoc _(.adoc)_ en PDF _(.pdf)_, vous devez installer quelques outils supplémentaires. - -==== -* *Installer `asciidoctor-pdf`* - -[source, bash] ----- -gem install asciidoctor-pdf ----- - -* *Utilisation AsciiDoctor-PDF* - -[source, bash] ----- -asciidoctor-pdf -a pdf-theme=my-theme.yml rapport.adoc ----- -==== - -== Ressources et liens utiles -* https://rubyinstaller.org/downloads/[Ruby Installer for Windows] -* https://docs.asciidoctor.org/asciidoc/latest/[Documentation Officielle AsciiDoc] -* https://docs.asciidoctor.org/asciidoctor/latest/[Documentation Officielle AsciiDoctor] \ No newline at end of file +Exemple : ```pandoc MAIN.md --toc --number-sections -o MAIN.pdf``` \ No newline at end of file