Review README script

README.md

@@ -1,4 +1,14 @@
-# Pairgoth engine
+# Pairgoth
+
+Welcome to pairgoth, your Go Pairing Engine!
+
+pairgoth is a Go tournament pairing engine designed to make your tournament experience effortless. pairgoth is the successor of [opengotha](https://github.com/lucvannier/opengotha), the well known pairing system software developed by [Luc Vannier](http://vannier.info/jeux/accueil.htm) and uses the same algorithm internally, as well as import and export features towards its format.
+
+pairgoth supports the Swiss pairing system, ideal for championships with no handicap games, as well as the MacMahon pairing system, more suited for classical tournaments and cups. It is still in a beta stage. Future versions will support more pairing systems and more features. Your feedback is most welcome!
+
+## How to use
+
+Please refer to [Pairgoth](https://pairgoth.jeudego.org) landing page.
 
 ## Sources structure
 
@@ -7,9 +17,13 @@
 ├── pairgoth.properties.example ............... Executable property file to instanciate
 ├── standalone.sh ............................. Executable run script, linux
 ├── standalone.bat............................. Executable run script, windows
-├── server.sh.................................. Server debugging script, linux
+├── server.sh.................................. Server launch script, linux
-├── client.sh.................................. Web client debugging script, linux
+├── client.sh.................................. Client launch script, linux
+├── debug-server.sh............................ Server debugging script, linux
+├── debug-client.sh............................ Client debugging script, linux
+├── debug.bat.................................. Standalone debugging script, windows
 ├── test.sh ................................... Executable test script, linux
+├── curl.sh ................................... API example script, linux
 ├── application ............................... Executable final packaging
 ├── webserver ................................. Web container
 ├── docker .................................... Docker packaging
@@ -23,7 +37,7 @@
         │       └── WEB-INF ................... Engine API webapp configuration
         └── test
             └── kotlin ........................ Engine webapp API unit tests
-└── view-webapp ............................... Web interface
+└── view-webapp ............................... View web application
 ```
 
 ## API Webapp sources structure
@@ -53,8 +67,6 @@ Just running `./standalone.sh` or `./standalone.bat` shoud build and run the eng
 
 ### Docker
 
-*docker container is not maintained for now - TODO*
-
 Under windows, please use the WSL.
 
 You need docker installed, and the current user being in the `docker` group.
@@ -69,5 +81,6 @@ The `./server.sh` will launch the server in debugging mode, with a remote debugg
 
 The `./client.sh` will launch the web client in debugging mode, with a remote debugger socket on port 5006.
 
+The corresponding `./debug-...` scripts will do the same with additional debugging features like automatic re-compilation of CSS files, automatic reloading of template files, etc.
 
 

debug-client.sh

@@ -14,6 +14,5 @@ trap 'kill $CSSWATCH; exit' INT
 CSSWATCH=$!
 
 export MAVEN_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:5006"
-#mvn --projects view-webapp -Dpairgoth.api.url=http://localhost:8085/api/ package jetty:run
 mvn -DskipTests=true --projects view-webapp package jetty:run -Dpairgoth.mode=client
 kill $CSSWATCH

oauth.sh

@@ -1,15 +0,0 @@
-#!/bin/bash
-
-trap 'kill $CSSWATCH; exit' INT
-( cd view-webapp; ./csswatch.sh ) &
-CSSWATCH=$!
-
-export MAVEN_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=*:5006"
-#mvn --projects view-webapp -Dpairgoth.api.url=http://localhost:8085/api/ package jetty:run
-mvn -DskipTests=true \
-	-Dpairgoth.auth=oauth \
-	-Dpairgoth.oauth.providers=ffg \
-	-Dpairgoth.oauth.ffg.secret=43f3a67bffcb5054d2f1b0e2a2374bdc \
-	-Dwebapp.external.url=http://localhost:8080 \
-	--projects view-webapp package jetty:run
-kill $CSSWATCH