From 5a85e16d06746fc3c7f81e0ec41a65e8e90beab6 Mon Sep 17 00:00:00 2001
From: Claude Brisson <claude@renegat.net>
Date: Fri, 19 May 2023 10:36:39 +0200
Subject: [PATCH] Document sources directory structure

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c8d7c6a..788607c 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,7 @@
 
 ## Sources structure
 
+```
 .
 ├── pairgoth.properties.example ............... Executable property file to instanciate
 ├── debug.sh .................................. Executable debug script, linux
@@ -23,9 +24,25 @@
         │       └── WEB-INF ................... Engine API webapp configuration
         └── test
             └── kotlin ........................ Engine webapp API unit tests
+```
 
-## Building
+## Webapp sources structure
 
+```
+webapp/src/main/kotlin/org/jeudego/pairgoth
+├── api .................................... API handlers
+├── ext .................................... External: import/export features
+├── model .................................. Domain logic model
+├── pairing ................................ Pairing solvers
+├── store .................................. Persistence handlers
+├── util ................................... Various utilities
+└── web .................................... Web interface
+    └── sse ................................ Server Sent Events interface
+```
+
+Tests are located in `webapp/src/test/kotlin`
+
+## Building and running
 
 ### Executable
 
@@ -35,6 +52,8 @@ Copy and adapt `pairgoth.properties.example` towards `pairgoth.properties`.
 
 Just running `./run.sh` or `./run.bat` shoud build and run the engine .
 
+Run `/test.sh` to test the engine.
+
 ### Docker
 
 Under windows, please use the WSL.