mirror of
https://github.com/ddnet/ddnet.git
synced 2024-11-09 17:48:19 +00:00
Consistently indent bullet points
This commit is contained in:
heinrich5991
parent
03b13cb9f5
commit
19f0aa50bb
48
README.md
48
README.md
|
|
@ -80,23 +80,23 @@ DDNet requires additional libraries, some of which are bundled for the most comm
|
||||||
The following is a non-exhaustive list of build arguments that can be passed to the `cmake` command-line tool in order to enable or disable options in build time:
|
The following is a non-exhaustive list of build arguments that can be passed to the `cmake` command-line tool in order to enable or disable options in build time:
|
||||||
|
|
||||||
* **-DCMAKE_BUILD_TYPE=[Release|Debug|RelWithDebInfo|MinSizeRel]** <br>
|
* **-DCMAKE_BUILD_TYPE=[Release|Debug|RelWithDebInfo|MinSizeRel]** <br>
|
||||||
An optional CMake variable for setting the build type. If not set, defaults to "Release" if `-DDEV=ON` is **not** used, and "Debug" if `-DDEV=ON` is used. See `CMAKE_BUILD_TYPE` in CMake Documentation for more information.
|
An optional CMake variable for setting the build type. If not set, defaults to "Release" if `-DDEV=ON` is **not** used, and "Debug" if `-DDEV=ON` is used. See `CMAKE_BUILD_TYPE` in CMake Documentation for more information.
|
||||||
|
|
||||||
* **-DPREFER_BUNDLED_LIBS=[ON|OFF]** <br>
|
* **-DPREFER_BUNDLED_LIBS=[ON|OFF]** <br>
|
||||||
Whether to prefer bundled libraries over system libraries. Setting to ON will make DDNet use third party libraries available in the `ddnet-libs` folder, which is the git-submodule target of the [ddnet-libs](https://github.com/ddnet/ddnet-libs) repository mentioned above -- Useful if you do not have those libraries installed and want to avoid building them. If set to OFF, will only use bundled libraries when system libraries are not found. Default value is OFF.
|
Whether to prefer bundled libraries over system libraries. Setting to ON will make DDNet use third party libraries available in the `ddnet-libs` folder, which is the git-submodule target of the [ddnet-libs](https://github.com/ddnet/ddnet-libs) repository mentioned above -- Useful if you do not have those libraries installed and want to avoid building them. If set to OFF, will only use bundled libraries when system libraries are not found. Default value is OFF.
|
||||||
|
|
||||||
* **-DWEBSOCKETS=[ON|OFF]** <br>
|
* **-DWEBSOCKETS=[ON|OFF]** <br>
|
||||||
Whether to enable WebSocket support for server. Setting to ON requires the `libwebsockets-dev` library installed. Default value is OFF.
|
Whether to enable WebSocket support for server. Setting to ON requires the `libwebsockets-dev` library installed. Default value is OFF.
|
||||||
|
|
||||||
* **-DMYSQL=[ON|OFF]** <br>
|
* **-DMYSQL=[ON|OFF]** <br>
|
||||||
Whether to enable MySQL/MariaDB support for server. Requires at least MySQL 8.0 or MariaDB 10.2. Setting to ON requires the `libmariadbclient-dev` library installed, which are also provided as bundled libraries for the common platforms. Default value is OFF.
|
Whether to enable MySQL/MariaDB support for server. Requires at least MySQL 8.0 or MariaDB 10.2. Setting to ON requires the `libmariadbclient-dev` library installed, which are also provided as bundled libraries for the common platforms. Default value is OFF.
|
||||||
|
|
||||||
Note that the bundled MySQL libraries might not work properly on your system. If you run into connection problems with the MySQL server, for example that it connects as root while you chose another user, make sure to install your system libraries for the MySQL client. Make sure that the CMake configuration summary says that it found MySQL libs that were not bundled (no "using bundled libs").
|
Note that the bundled MySQL libraries might not work properly on your system. If you run into connection problems with the MySQL server, for example that it connects as root while you chose another user, make sure to install your system libraries for the MySQL client. Make sure that the CMake configuration summary says that it found MySQL libs that were not bundled (no "using bundled libs").
|
||||||
|
|
||||||
* **-DTEST_MYSQL=[ON|OFF]** <br>
|
* **-DTEST_MYSQL=[ON|OFF]** <br>
|
||||||
Whether to test MySQL/MariaDB support in GTest based tests. Default value is OFF.
|
Whether to test MySQL/MariaDB support in GTest based tests. Default value is OFF.
|
||||||
|
|
||||||
Note that this requires a running MySQL/MariaDB database on localhost with this setup:
|
Note that this requires a running MySQL/MariaDB database on localhost with this setup:
|
||||||
|
|
||||||
```
|
```
|
||||||
CREATE DATABASE ddnet;
|
CREATE DATABASE ddnet;
|
||||||
|
|
@ -106,47 +106,47 @@ FLUSH PRIVILEGES;
|
||||||
```
|
```
|
||||||
|
|
||||||
* **-DAUTOUPDATE=[ON|OFF]** <br>
|
* **-DAUTOUPDATE=[ON|OFF]** <br>
|
||||||
Whether to enable the autoupdater. Packagers may want to disable this for their packages. Default value is ON for Windows and Linux.
|
Whether to enable the autoupdater. Packagers may want to disable this for their packages. Default value is ON for Windows and Linux.
|
||||||
|
|
||||||
* **-DCLIENT=[ON|OFF]** <br>
|
* **-DCLIENT=[ON|OFF]** <br>
|
||||||
Whether to enable client compilation. If set to OFF, DDNet will not depend on Curl, Freetype, Ogg, Opus, Opusfile, and SDL2. Default value is ON.
|
Whether to enable client compilation. If set to OFF, DDNet will not depend on Curl, Freetype, Ogg, Opus, Opusfile, and SDL2. Default value is ON.
|
||||||
|
|
||||||
* **-DVIDEORECORDER=[ON|OFF]** <br>
|
* **-DVIDEORECORDER=[ON|OFF]** <br>
|
||||||
Whether to add video recording support using FFmpeg to the client. Default value is ON.
|
Whether to add video recording support using FFmpeg to the client. Default value is ON.
|
||||||
|
|
||||||
* **-DDOWNLOAD_GTEST=[ON|OFF]** <br>
|
* **-DDOWNLOAD_GTEST=[ON|OFF]** <br>
|
||||||
Whether to download and compile GTest. Useful if GTest is not installed and, for Linux users, there is no suitable package providing it. Default value is OFF.
|
Whether to download and compile GTest. Useful if GTest is not installed and, for Linux users, there is no suitable package providing it. Default value is OFF.
|
||||||
|
|
||||||
* **-DDEV=[ON|OFF]** <br>
|
* **-DDEV=[ON|OFF]** <br>
|
||||||
Whether to optimize for development, speeding up the compilation process a little. If enabled, don't generate stuff necessary for packaging. Setting to ON will set CMAKE\_BUILD\_TYPE to Debug by default. Default value is OFF.
|
Whether to optimize for development, speeding up the compilation process a little. If enabled, don't generate stuff necessary for packaging. Setting to ON will set CMAKE\_BUILD\_TYPE to Debug by default. Default value is OFF.
|
||||||
|
|
||||||
* **-DUPNP=[ON|OFF]** <br>
|
* **-DUPNP=[ON|OFF]** <br>
|
||||||
Whether to enable UPnP support for the server.
|
Whether to enable UPnP support for the server.
|
||||||
You need to install `libminiupnpc-dev` on Debian, `miniupnpc` on Arch Linux.
|
You need to install `libminiupnpc-dev` on Debian, `miniupnpc` on Arch Linux.
|
||||||
Default value is OFF.
|
Default value is OFF.
|
||||||
|
|
||||||
* **-DVULKAN=[ON|OFF]** <br>
|
* **-DVULKAN=[ON|OFF]** <br>
|
||||||
Whether to enable the vulkan backend.
|
Whether to enable the vulkan backend.
|
||||||
On Windows you need to install the Vulkan SDK and set the `VULKAN_SDK` environment flag accordingly.
|
On Windows you need to install the Vulkan SDK and set the `VULKAN_SDK` environment flag accordingly.
|
||||||
Default value is ON for Windows x86\_64 and Linux, and OFF for Windows x86 and macOS.
|
Default value is ON for Windows x86\_64 and Linux, and OFF for Windows x86 and macOS.
|
||||||
|
|
||||||
* **-GNinja** <br>
|
* **-GNinja** <br>
|
||||||
Use the Ninja build system instead of Make. This automatically parallelizes the build and is generally faster. Compile with `ninja` instead of `make`. Install Ninja with `sudo apt install ninja-build` on Debian, `sudo pacman -S --needed ninja` on Arch Linux.
|
Use the Ninja build system instead of Make. This automatically parallelizes the build and is generally faster. Compile with `ninja` instead of `make`. Install Ninja with `sudo apt install ninja-build` on Debian, `sudo pacman -S --needed ninja` on Arch Linux.
|
||||||
|
|
||||||
* **-DCMAKE_CXX_LINK_FLAGS=[FLAGS]** <br>
|
* **-DCMAKE_CXX_LINK_FLAGS=[FLAGS]** <br>
|
||||||
Custom flags to set for compiler when linking.
|
Custom flags to set for compiler when linking.
|
||||||
|
|
||||||
* **-DEXCEPTION_HANDLING=[ON|OFF]** <br>
|
* **-DEXCEPTION_HANDLING=[ON|OFF]** <br>
|
||||||
Enable exception handling (only works with Windows as of now, uses DrMingw there). Default value is OFF.
|
Enable exception handling (only works with Windows as of now, uses DrMingw there). Default value is OFF.
|
||||||
|
|
||||||
* **-DIPO=[ON|OFF]** <br>
|
* **-DIPO=[ON|OFF]** <br>
|
||||||
Enable interprocedural optimizations, also known as Link Time Optimization (LTO). Default value is OFF.
|
Enable interprocedural optimizations, also known as Link Time Optimization (LTO). Default value is OFF.
|
||||||
|
|
||||||
* **-DFUSE_LD=[OFF|LINKER]** <br>
|
* **-DFUSE_LD=[OFF|LINKER]** <br>
|
||||||
Linker to use. Default value is OFF to try mold, lld, gold.
|
Linker to use. Default value is OFF to try mold, lld, gold.
|
||||||
|
|
||||||
* **-DSECURITY_COMPILER_FLAGS=[ON|OFF]** <br>
|
* **-DSECURITY_COMPILER_FLAGS=[ON|OFF]** <br>
|
||||||
Whether to set security-relevant compiler flags like `-D_FORTIFY_SOURCE=2` and `-fstack-protector-all`. Default Value is ON.
|
Whether to set security-relevant compiler flags like `-D_FORTIFY_SOURCE=2` and `-fstack-protector-all`. Default Value is ON.
|
||||||
|
|
||||||
Running tests (Debian/Ubuntu)
|
Running tests (Debian/Ubuntu)
|
||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue