mirror of
https://git.roussel.pro/telecom-paris/pact.git
synced 2026-02-09 10:30:17 +01:00
24 lines
1.5 KiB
Markdown
24 lines
1.5 KiB
Markdown
Ceci est votre dépôt pour le projet PACT.
|
|
|
|
Vous **DEVEZ** modifier ce fichier (`README.md`) et créer tous les
|
|
répertoires et fichiers dont vous aurez besoin pour votre projet.
|
|
|
|
# Important, le rapport d'avancement
|
|
|
|
Le répertoire `rapport` contient un squelette pour votre rapporte d'avancement.
|
|
Ce répertoire **ne doit pas être renommé** ni le fichier `README.adoc` qu'il contient.
|
|
Le fichier `README.adoc` est le point d'entrée du rapport.
|
|
|
|
Il est rédigé en utilisant le langage [**AsciiDoc**](http://asciidoc.org/).
|
|
La syntaxe est supportée par GitLab qui le formatera correctement dans l'interface Web.
|
|
|
|
Le document final sera généré en utilisant l'outil [Asciidoctor](http://asciidoctor.org/) qui supporte les mêmes extensions que GitLab (pour les équations par exemple).
|
|
Un résumé de la syntaxe supportée est accessible [ici](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/).
|
|
|
|
Vous pouvez éditer les différents fichiers en utilisant *votre éditeur de texte favori*.
|
|
Si vous n'en avez pas, vous pouvez, par exemple utiliser:
|
|
|
|
- [**Visual Studio Code**](https://code.visualstudio.com/) avec l'extension [AsciiDoc](https://marketplace.visualstudio.com/items?itemName=asciidoctor.asciidoctor-vscode) qui ajoute coloration syntaxique et rendu en temps réel.
|
|
- Ou bien sûr votre éditeur de text préféré **Sublim Text**, **Vim**, **Emacs**,…
|
|
- Une extension pour navigateur Web est aussi disponible pour visualiser le résultat ([**ici**](https://github.com/asciidoctor/asciidoctor-browser-extension)).
|