Skip to content
Snippets Groups Projects
Commit 4157c549 authored by Alban Sonneville's avatar Alban Sonneville
Browse files

README.md modifications

parent 8a1df369
Branches
No related tags found
No related merge requests found
= SAE 2.03 ISR - README # SAE 2.03 ISR - README
== Liste des membres de l'équipe ## Liste des membres de l'équipe
* POZZO Kilian : kilian.pozzo.etu@univ-lille.fr - LEPOUTRE Alexandre : alexandre.lepoutre.etu@univ-lille.fr
* NKANZA Benn : benn.nkanza.etu@univ-lille.fr - SEULIN Ethan : ethan.seulin.etu@univ-lille.fr
* VEROULIDZE Anri : anri.veroulidze.etu@univ-lille.fr - SONNEVILLE Alban : alban.sonneville.etu@univ-lille.fr
* NOURDINE El-Khair : el-khair.nourdine.etu@univ-lille.fr
== Prérequis ## Prérequis
====
*Ruby*: AsciiDoctor nécessite `Ruby` pour être exécuté. Assurez-vous d'avoir *Ruby* installé sur votre système.
Vous pouvez vérifier si Ruby est installé en ouvrant l'invite de commande _(cmd)_ et en exécutant la commande :
[source, bash] ## Installation
----
ruby -v
----
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)_. + 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.
Assurez-vous que vous avez https://rubygems.org/[RubyGems] installé pour pouvoir installer AsciiDoctor.
====
== 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 :
==== - Sous Windows, vous pouvez utiliser l'invite de commande classique ou le terminal PowerShell.
*Installer AsciiDoctor via RubyGems* - 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. Une fois installée, vous pouvez vérifier l'installation avec la commande ```pandoc --version```
* Installez le gem AsciiDoctor en exécutant la commande suivante :
[source, bash] ## Utilisation de Pandoc
----
gem install asciidoctor
----
* 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] ```pandoc -f markdown -t html -o MAIN.html MAIN.md```
----
asciidoctor -v
----
====
== Utilisation AsciiDoctor Et pour le convertir en pdf:
==== ```pandoc -f markdown -t html -o MAIN.html MAIN.md```
Pour convertir le rapport AsciiDoc _(.adoc)_ en HTML _(.html)_, utilisez la commande suivante :
[source, bash] Certaines options sont disponible comme avoir un sommaires grace à ```--toc```,
---- ou encore avoir une numérotation automatique ```--number-sections```:
asciidoctor rapport.adoc
----
====
== Prérequis supplémentaires pour la conversion en PDF Exemple : ```pandoc MAIN.md --toc --number-sections -o MAIN.pdf```
Si vous souhaitez convertir le rapport AsciiDoc _(.adoc)_ en PDF _(.pdf)_, vous devez installer quelques outils supplémentaires. \ No newline at end of file
====
* *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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment