Update readme
This commit is contained in:
parent
0ae8fc3a5a
commit
5a0ef358a4
|
@ -3,13 +3,13 @@
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- CMake (tested on 3.17)
|
- CMake (tested on 3.17)
|
||||||
- C99+ compiler
|
- C99 compiler
|
||||||
|
|
||||||
## Building
|
## Building
|
||||||
|
|
||||||
First, create the required build files (usually the Makefile)
|
First, create the required build files (usually the Makefile)
|
||||||
```sh
|
```sh
|
||||||
cmake -H . -B build/ -DCMAKE_BUILD_TYPE=Release
|
cmake -B build/ -DCMAKE_BUILD_TYPE=Release .
|
||||||
```
|
```
|
||||||
| Option | Description | Type | Default | Supported since |
|
| Option | Description | Type | Default | Supported since |
|
||||||
|:------------------:|:----------------------------------------------------------------------:|:--------:|:-------:|:---------------:|
|
|:------------------:|:----------------------------------------------------------------------:|:--------:|:-------:|:---------------:|
|
||||||
|
@ -17,13 +17,14 @@ cmake -H . -B build/ -DCMAKE_BUILD_TYPE=Release
|
||||||
| BUILD_VALIDATORS | Build validators that check if the messages follow the standards (WIP) | boolean | true | 2020.10.29 |
|
| BUILD_VALIDATORS | Build validators that check if the messages follow the standards (WIP) | boolean | true | 2020.10.29 |
|
||||||
| BUILD_TESTS | Build tests that check if the build results behave as they should | boolean | false | - |
|
| BUILD_TESTS | Build tests that check if the build results behave as they should | boolean | false | - |
|
||||||
| BUILD_IRCV3 | Build IRCv3 support (WIP) | boolean | true | - |
|
| BUILD_IRCV3 | Build IRCv3 support (WIP) | boolean | true | - |
|
||||||
|
| CODE_ANALYZER | Use static analysis tools | boolean | true | 2020.12.20 |
|
||||||
|
| CODE_COVERAGE | Generate code coverage output | boolean | false | 2020.12.20 |
|
||||||
|
|
||||||
Following that, just use your build system and compile it
|
Following that, just use your build system and compile it
|
||||||
|
|
||||||
Example for **make**:
|
Example for **make**:
|
||||||
```sh
|
```sh
|
||||||
cd build/
|
make -C build
|
||||||
make
|
|
||||||
```
|
```
|
||||||
|
|
||||||
You now should have the library built at `build/libuirc.so` *(or your build output path)*
|
You now should have the library built at `build/libuirc.so` *(or your build output path)*
|
||||||
|
|
Reference in New Issue