Adapt scripts and doc
This commit is contained in:
20
README.md
20
README.md
@@ -5,10 +5,10 @@
|
||||
```
|
||||
.
|
||||
├── pairgoth.properties.example ............... Executable property file to instanciate
|
||||
├── debug.sh .................................. Executable debug script, linux
|
||||
├── debug.bat ................................. Executable debug script, windows
|
||||
├── run.sh .................................... Executable run script, linux
|
||||
├── run.bat ................................... Executable run script, windows
|
||||
├── standalone.sh ............................. Executable run script, linux
|
||||
├── standalone.bat............................. Executable run script, windows
|
||||
├── server.sh.................................. Server debugging script, linux
|
||||
├── client.sh.................................. Web client debugging script, linux
|
||||
├── test.sh ................................... Executable test script, linux
|
||||
├── application ............................... Executable final packaging
|
||||
├── webserver ................................. Web container
|
||||
@@ -49,10 +49,12 @@ You need maven installed.
|
||||
|
||||
Copy and adapt `pairgoth.properties.example` towards `pairgoth.properties`, if needed. Otherwise pairgoth will use default properties (TODO - list them)
|
||||
|
||||
Just running `./run.sh` or `./run.bat` shoud build and run the engine .
|
||||
Just running `./standalone.sh` or `./standalone.bat` shoud build and run the engine and the view webapps.
|
||||
|
||||
### 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.
|
||||
@@ -61,3 +63,11 @@ Copy and adapt `docker/pairgoth.properties.example` towards `docker/pairgoth.pro
|
||||
|
||||
Just running `./run.sh` in the `docker` directory should build and run the engine.
|
||||
|
||||
## Debugging
|
||||
|
||||
The `./server.sh` will launch the server in debugging mode, with a remote debugger socket on port 5005.
|
||||
|
||||
The `./client.sh` will launch the web client in debugging mode, with a remote debugger socket on port 5006.
|
||||
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user