chore: Minor changes

2026-02-22 20:59:20 +01:00
parent 3dd2c389b8
commit dac6d666b2
5 changed files with 55 additions and 9 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,31 @@
+# Terminal Game
+
+A multiplayer terminal-based game built with Java, utilizing WebSockets for communication and Lanterna for the text-based user interface.
+
+## Project Structure
+
+*   **game**: Client application (TUI).
+*   **server**: WebSocket server.
+*   **common**: Shared libraries and logic.
+
+## Requirements
+
+*   Java 25
+*   Maven
+
+## How to Run
+
+1.  Build the project:
+    ```bash
+    mvn clean install
+    ```
+
+2.  Start the server:
+    ```bash
+    mvn compile exec:java -pl server -am
+    ```
+
+3.  Start the client (in a new terminal):
+    ```bash
+    mvn compile exec:java -pl game -am
+    ```