diff --git a/README.md b/README.md index ee810b1..69e985a 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,22 @@ # Projet de GLA + Version 2024 ## Description -Ceci est l'archetype de projet de Génie Logiciel Avancé (GLA). -Il s'agit d'un projet Java. Ce dépôt définit un système de build et une application simple. Il est nécéssaire de consulter le fichier [CONTRIBUTING.md](CONTRIBUTING.md) pour utiliser ce dépôt. +Ceci est l'archétype de projet de Génie Logiciel Avancé (GLA). + +Il s'agit d'un projet Java. Ce dépôt définit un système de build et une application simple. Il est nécessaire de consulter le fichier [CONTRIBUTING.md](CONTRIBUTING.md) pour utiliser ce dépôt. ## Lancement du programme -Ce projet utilise [maven](https://maven.apache.org/) de Apache pour la gestion de construction. -Afin de compiler et lancer les tests, éxecutez simplement -``` +Ce projet utilise [maven](https://maven.apache.org/) d'Apache pour la gestion de construction. + +Afin de compiler et lancer les tests, exécutez simplement + +```bash mvn verify +``` Afin de vérifier les tests via JaCoCo. Les résultats du test sont dans `target/site/jacoco/index.html`. @@ -24,12 +29,12 @@ Par la suite, `mvn jacoco:report` suffit. Dans sa version initiale, le programme fournit est un simple code qui se lance en terminal ou en application graphique. -Une fois le programme compilé, vous trouverez un jar executable dans le dossier target. Au nom de jar près (version changeante), vous pourrez l'exécuter avec: -``` +Une fois le programme compilé, vous trouverez un jar exécutable dans le dossier `target`. Au nom de jar près (version changeante), vous pourrez l'exécuter avec : + +```bash java -jar project-2024.1.0.0-SNAPSHOT.jar --info ``` L'option de lancement `--info` causera l'affichage dans la console d'informations de l'application. L'option de lancement `--gui` causera l'ouverture d'une fenêtre affichant le logo de l'Université de Paris. -