Skip to content

docs: finaliser la documentation technique du README - #69

Merged
rmouahid merged 1 commit into
developfrom
docs/36-readme-final
Oct 11, 2026
Merged

rmouahid merged 1 commit into
developfrom
docs/36-readme-final

Conversation

@rmouahid

Copy link
Copy Markdown
Owner

Contexte

#36 : finaliser le README pour qu'il serve de documentation technique complète, permettant à n'importe quel développeur de comprendre, installer et lancer le projet.

Changements

Ajouts

  • Structure du projet : arborescence commentée (lanceurs, modèles, docs, packages model / view / controller, tests).
  • Installation complétée : mvn compile récupère JavaFX et JUnit, rien d'autre à installer.
  • Modèle prêt à l'emploi : comment ouvrir templates/template1.simcel. Le fichier est en 50×30 (dimensions vérifiées en le désérialisant), soit la taille par défaut, donc il se charge directement.
  • Contrôles complétés : redimensionnement de la grille (10–300 × 10–200, « Nouvelle grille »), vitesse de 50 à 1000 ms, et liste nominative des 9 outils d'édition.
  • Mode console : syntaxe des commandes (wind NE 3…) et condition d'arrêt (--ticks atteint ou plus aucune cellule en feu).
  • Diagrammes UML affichés dans le README (classes, cas d'utilisation, séquence, états), au lieu d'un simple lien.
  • Documents du projet : sujet, spécification, milestones et rapport final dans docs/Livrables/.
  • Dépannage : version de Java, JavaFX sans écran, java -jar, fichier .simcel incompatible, couleurs ANSI.
  • Conventions : branches (develop comme cible des PR, feature/*) et Conventional Commits.

Corrections

  • Le README annonçait une commande Stop, absente de l'interface : les boutons sont Démarrer, Pause, Pas avant, Pas arrière et Reset.
  • mvn package était présenté comme générant « le JAR ». Ce JAR ne contient que les classes, sans JavaFX ni classe principale déclarée, donc java -jar échoue (« no main manifest attribute », vérifié). Le README l'explique et renvoie vers mvn javafx:run et launchers/.

Vérifications

Chaque affirmation a été vérifiée dans le code ou par exécution :

  • valeurs par défaut de Main (GUI 50×30, CLI 40×20) ;
  • plages des curseurs de MainWindow ;
  • énumérations EditTool et WindDirection ;
  • message d'erreur au chargement (« Fichier incompatible ») ;
  • mvn test : 54 tests, tous verts ;
  • java -jar sur le JAR produit ;
  • dimensions de template1.simcel.

Aucun code modifié.

Closes #36

Ajoute l'arborescence du projet, l'installation complète, l'usage du
modèle templates/template1.simcel, les diagrammes UML affichés
directement, la liste des livrables et une section de dépannage.
Corrige deux inexactitudes : il n'y a pas de commande Stop dans
l'interface, et le JAR de mvn package n'est pas exécutable seul
(ni JavaFX ni classe principale). Décrit aussi le redimensionnement de
la grille, la plage de vitesse et les outils d'édition.

Closes #36

@rmouahid rmouahid left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revue

Relu le README complet comme un nouveau développeur, et confronté chaque ajout au code.

  • Les chemins cités existent (launchers/, templates/template1.simcel, les 4 PNG de docs/uml/, les 4 PDF de docs/Livrables/) et les images s'affichent dans l'aperçu GitHub.
  • Les valeurs documentées correspondent au code : défauts de Main, curseurs 50–1000 ms et 10–300 × 10–200 de MainWindow, 9 valeurs de EditTool, 8 directions de WindDirection (SO, O, NO en français), arrêt du mode console sur --ticks ou absence de feu actif (hasActiveFire).
  • Les deux corrections sont justes : aucun bouton Stop n'existe (seul SimulationController.stop(), appelé en interne), et le JAR de mvn package échoue bien avec java -jar (« no main manifest attribute »).
  • Ce qui était déjà correct est conservé (modèle de propagation, architecture MVC/Observer, flux de données, tests).

Remarque hors périmètre : rendre le JAR exécutable (plugin d'assemblage avec JavaFX) serait une amélioration de build, à traiter dans une issue séparée si utile.

CI verte (54 tests). Approuvé pour la fusion.

@rmouahid
rmouahid merged commit 244a09d into develop Oct 11, 2026
1 check passed
@rmouahid
rmouahid deleted the docs/36-readme-final branch October 11, 2026 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant