From ce3998dca4a580419783e0949fb2c86d9f02e4d2 Mon Sep 17 00:00:00 2001
From: Lorenzo <10797603@polimi.it>
Date: Fri, 28 Jun 2024 01:30:23 +0200
Subject: [PATCH] Added documentation for JARs files.

---
 deliverables/JARs/README.md | 31 +++++++++++++++++++++++++++++++
 deliverables/README.md      |  3 ++-
 2 files changed, 33 insertions(+), 1 deletion(-)
 create mode 100644 deliverables/JARs/README.md

diff --git a/deliverables/JARs/README.md b/deliverables/JARs/README.md
new file mode 100644
index 00000000..ecdf1e87
--- /dev/null
+++ b/deliverables/JARs/README.md
@@ -0,0 +1,31 @@
+# Deployment
+
+## Server
+
+It is required to put the correct server IPv4 address in the Config.json file in order to let RMI work properly.
+
+Here is an example of the Config.json file:
+
+```json
+{
+  "socketPort": 30000,
+  "rmiPort": 30001,
+  "pingTimePeriod": 5000,
+  "socketReadTimeout": 100,
+  "maxPingCount": 3,
+  "serverIp": "192.168.178.20",
+  "endGameDueToDisconnectionTimeout": 120000
+}
+```
+
+## Client
+
+If the client is running on a Windows machine it is required to enable UTF-8 encoding in the terminal to let the client display the special characters correctly for TUI.
+
+To enable UTF-8 encoding in the terminal, run the following command:
+
+```powershell
+PS C:\> $OutputEncoding = [System.Console]::OutputEncoding = [System.Console]::InputEncoding = [System.Text.Encoding]::UTF8
+PS C:\> $PSDefaultParameterValues['*:Encoding'] = 'utf8'
+PS C:\> java -jar .\IS24-AM32-0.1-CLIENT.jar
+```
diff --git a/deliverables/README.md b/deliverables/README.md
index 35e7e030..c71e9870 100644
--- a/deliverables/README.md
+++ b/deliverables/README.md
@@ -3,4 +3,5 @@
 - ☑️ InitialUML: This folder contains the high-level UML diagram of the project.
 - ☑️ FinalUML: This folder contains the detailed UML diagrams of the project. Generated using IntelliJ IDEA.
 - ☑️ PeerReview: This folder contains the peer review documents. In the second peer review it is also explained the communication protocol between Client and Server.
-- ☑️ JavaDoc: This folder contains the JavaDoc of the project exported in HTML format.
\ No newline at end of file
+- ☑️ JavaDoc: This folder contains the JavaDoc of the project exported in HTML format.
+- ☑️ JARs: This folder contains the JAR files of the project.