Skip to content

Commit 7d32563

Browse files
committed
update readme
1 parent 3e2686b commit 7d32563

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,27 @@ cmake -B build -H.
3232
cd build
3333
make -j
3434
```
35+
#### Building options
36+
37+
Trantor provides some building options, you can enable or disable them by setting the corresponding variables to `ON` or `OFF` in the cmake command line, cmake file etc...
38+
39+
| Option name | Description | Default value |
40+
| :--- | :--- | :--- |
41+
| BUILD_SHARED_LIBS | Build Trantor as a shared lib | OFF |
42+
| BUILD_TESTING | Build tests | OFF |
43+
| BUILD_DOC | Build Doxygen documentation | OFF |
44+
| BUILD_DEPENDENCIES | Fetch and build dependencies, this allow you use latest or change dependencies version, if you don't want to use system package manager provided | OFF |
45+
| TRANTOR_USE_SPDLOG | Allow using the spdlog logging library | ON |
46+
| TRANTOR_USE_C-ARES | Allow using C-ARES | OFF |
47+
| TRANTOR_TLS_PROVIDER | TLS provider for trantor. Valid options are 'none', 'openssl', 'botan-3', 'auto'. | auto |
48+
49+
> With option `BUILD_DEPENDENCIES` on, the related dependencies source will download and build automatically based on the options settings, this make develop more easily in `Windows`.
50+
>* Build `openssl` needs `perl` and build `botan` needs `python`.
51+
>* Passing `-DCMAKE_TOOLCHAIN_FILE="your-toolchain.cmake"` will turn off `BUILD_DEPENDENCIES`.
52+
53+
> There are some scripts named start with `deps.*` for you to quickly install all dependencies also.
54+
>* If you want to use system installed package manager (such as: brew, apt, dnf) provided dependencies, please turn off option `BUILD_DEPENDENCIES`.
55+
>* If these scripts is not fit your system, you can turn on option `BUILD_DEPENDENCIES`.
3556
3657
## Licensing
3758
Trantor - A non-blocking I/O based TCP network library, using C++14.

0 commit comments

Comments
 (0)