final readme

2026-06-19 23:15:41 +02:00
parent db65e0a8be
commit d192b6ee9a
1 changed files with 54 additions and 0 deletions
@@ -166,6 +166,60 @@ src/main/java/it/polimi/ingsw/gc14/

 ---

+## Deliverables
+
+All deliverables are located in the [`deliverables/`](deliverables/) folder and organized as follows:
+
+### Coverage
+[`deliverables/Coverage/`](deliverables/Coverage/)
+
+Contains code-coverage reports generated by JaCoCo. The folder includes screenshot summaries (`.JPG`) and the full HTML report under `htmReport/` — open `htmReport/index.html` in a browser for the interactive view.
+
+### JAR
+[`deliverables/JAR/`](deliverables/JAR/)
+
+Executable fat-JARs for all three components of the application:
+
+| File | Role |
+|---|---|
+| `Server.jar` | Game server |
+| `ClientTUI.jar` | Text-based client |
+| `ClientGUI.jar` | JavaFX graphical client |
+
+See the **Launch** sections above for usage instructions.
+
+### Javadoc
+[`deliverables/JAVADOC/`](deliverables/JAVADOC/index.html)
+
+Auto-generated API documentation for the entire project. Open [`deliverables/JAVADOC/index.html`](deliverables/JAVADOC/index.html) in a browser to browse packages and classes.
+
+### UML Diagrams
+[`deliverables/UML/`](deliverables/UML/)
+
+Static UML class diagrams describing the project architecture:
+
+| File | Content |
+|---|---|
+| `Model_UML.pdf` | Full model layer class diagram |
+| `MiniModel_UML.pdf` | Simplified model overview |
+| `Server_UML_detail.pdf` | Server-side component detail |
+| `Client_UML_detail.pdf` | Client-side component detail |
+
+### Sequence Diagrams
+[`deliverables/Sequence_Diagrams/`](deliverables/Sequence_Diagrams/)
+
+UML sequence diagrams covering the main network flows:
+
+| File | Scenario |
+|---|---|
+| `SEQ_RMI_Connection.png` | RMI client connection handshake |
+| `SEQ_RMI_FULL.png` | Full RMI game flow |
+| `SEQ_TCP_Connection.png` | TCP client connection handshake |
+| `SEQ_TCP_FULL.png` | Full TCP game flow |
+| `SEQ_TCP_Reconnection.png` | TCP client reconnection after disconnect |
+
+---
+
 ## Persistence — Technical Details

 The save file is created in the directory from which the server JAR is launched: