2.1.3 : Le readme
Il est possible d'ajouter un fichier readme.md (ou readme.txt mais la mise en forme du markdown est plus jolie) dans chaque dossier de votre projet. Ces pages seront affichées dans l'interface de Gitlab, ce qui permet de faire un peu de mise en forme, voire ajouter quelques points de documentation là ou cela est nécéssaire. Mais n'oubliez pas la vraie documentation (voir section 2.1.4).
Pour écrire notre readme.md correctement, il est nécessaire de connaître où nous sauvegarderons notre projet. Mettons que nous allons le sauvegarder à l'adresse https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI noteBien entendu, vous allez devoir adapter tous les chemins pour qu'ils fonctionnent avec l'adresse de votre projet., nous pouvons déduire :
- Le lien vers le projet noteJe suis d'accord que ce n'est pas très utile qu'une page donne un lien vers elle même mais il y a sûrement des cas ou cela peut servir... ou pas
- Le lien vers le badge du pipeline d'intégration continue du projet : https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI/badges/master/pipeline.svg
- Le lien vers le badge de la courture des tests : https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI/badges/master/coverage.svg
- Le lien vers la documentation et la couverture de tests générées par l'intégration continue : https://cta-lapp.pages.in2p3.fr/COURS/TESTS/TestGitlabCI/. Si vous avec un doute, cette adresse est disponible dans votre projet à Settings->PagesnoteIl faut reconnaître que dans notre cas, cette information ne sert pas à grand chose car nous n'avons pas encore créer notre projet sur Gitlab.
Commençons par ajouter un logo :
1 2 |
----
|
Et ajoutons les badges Gitlab qui montreront si le dernier CI est passé et l'évaluation de la couverture des tests :
1 2 |
[](https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI/-/commits/master) [](https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI/-/commits/master) |
Une section pour définir où se situe le code (même si elle pointe vers la page courante) :
1 2 3 |
# Code
https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI
|
La documentation du projet (sur pages) :
1 2 3 |
# Documentation
https://cta-lapp.pages.in2p3.fr/COURS/TESTS/TestGitlabCI/
|
La liste des dépendences de notre projet :
1 2 3 4 5 |
# Requirements
- c++ compiler >= 9.3
- cmake >= 3
- make >= 4
|
Dans notre cas, la version du compilateur importe peu, car nous n'utiliserons que la couverture des tests. Mais il est tout de même préférable d'avoir une version récente de cmake, et de même pour make.
Les intructions pour télécharger et installer notre projet
1 2 3 4 5 6 7 |
# Installation for Users ``` git clone https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI.git cd TestGitlabCI ./install.sh ``` |
Bien entendu, vous pouvez ajouter tout ce que vous voulez
Le fichier readme.md complet :
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
<!-- readme.md -->  ---- [](https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI/-/commits/master) [](https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI/-/commits/master) # Code https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI # Documentation https://cta-lapp.pages.in2p3.fr/COURS/TESTS/TestGitlabCI/ # Requirements - c++ compiler >= 9.3 - cmake >= 3 - make >= 4 # Installation for Users ``` git clone https://gitlab.in2p3.fr/CTA-LAPP/COURS/TESTS/TestGitlabCI.git cd TestGitlabCI ./install.sh ``` |
Vous pouvez le télécharger ici.