diff --git a/README.md b/README.md index 2a50748a..6802aea2 100644 --- a/README.md +++ b/README.md @@ -59,17 +59,28 @@ To compile: cd build cmake .. make + +You can then run + make install +to get a cockatrice installation inside the `release` folder, or: + + make package + +to create a system-specific installation package. + The following flags can be passed to `cmake`: -- `-DWITH_SERVER=1` Build the server. -- `-DWITH_CLIENT=0` Do not build the client. -- `-DWITH_ORACLE=0` Do not build oracle. -- `-DPORTABLE=1` Build portable versions of client & oracle. -- `-DWITH_QT4=1` Force compilation to use Qt4 instead of Qt5. -- `-DCMAKE_BUILD_TYPE=Debug` Compile in debug mode. Enables extra logging output, debug symbols, and much more verbose compiler warnings. -- `-DUPDATE_TRANSLATIONS=1` Configure `make` to update the translation .ts files for new strings in the source code. Note: Running `make clean` will remove the .ts files. +- `-DWITH_SERVER=1` Whether to build the server (default 0 = no). +- `-DWITH_CLIENT=0` Whether to build the client (default 1 = yes). +- `-DWITH_ORACLE=0` Whether to build oracle (default 1 = yes). +- `-DPORTABLE=1` Build portable versions of client & oracle (default 0 = no). +- `-DWITH_QT4=1` Force compilation to use Qt4 instead of Qt5 (default 0 = no). +- `-DCMAKE_BUILD_TYPE=Debug` Compile in debug mode. Enables extra logging output, debug symbols, and much more verbose compiler warnings (default `Release`). +- `-DUPDATE_TRANSLATIONS=1` Configure `make` to update the translation .ts files for new strings in the source code. Note: Running `make clean` will remove the .ts files (default 0 = no). +- `-DTEST=1` Enable regression tests (default 0 = no). Note: needs googletest, will be downloaded on the fly if unavailable. To run tests: ```make test```. + #### Building servatrice Docker container `docker build -t servatrice .`