Repository navigation
docs: finaliser la documentation technique du README - #69
Merged
Merged
Conversation
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
commented
Oct 11, 2026
rmouahid
left a comment
Owner
Author
There was a problem hiding this comment.
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 dedocs/uml/, les 4 PDF dedocs/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 deMainWindow, 9 valeurs deEditTool, 8 directions deWindDirection(SO,O,NOen français), arrêt du mode console sur--ticksou absence de feu actif (hasActiveFire). - Les deux corrections sont justes : aucun bouton Stop n'existe (seul
SimulationController.stop(), appelé en interne), et le JAR demvn packageéchoue bien avecjava -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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
model/view/controller, tests).mvn compilerécupère JavaFX et JUnit, rien d'autre à installer.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.wind NE 3…) et condition d'arrêt (--ticksatteint ou plus aucune cellule en feu).docs/Livrables/.java -jar, fichier.simcelincompatible, couleurs ANSI.developcomme cible des PR,feature/*) et Conventional Commits.Corrections
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, doncjava -jaréchoue (« no main manifest attribute », vérifié). Le README l'explique et renvoie versmvn javafx:runetlaunchers/.Vérifications
Chaque affirmation a été vérifiée dans le code ou par exécution :
Main(GUI 50×30, CLI 40×20) ;MainWindow;EditTooletWindDirection;mvn test: 54 tests, tous verts ;java -jarsur le JAR produit ;template1.simcel.Aucun code modifié.
Closes #36