From 5a0ef358a464a4f0f097a4487f92c44f3e2accc4 Mon Sep 17 00:00:00 2001 From: Alex Denes Date: Wed, 30 Dec 2020 19:14:21 +0000 Subject: [PATCH] Update readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dc7bb60..871d36f 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ ## Requirements - CMake (tested on 3.17) -- C99+ compiler +- C99 compiler ## Building First, create the required build files (usually the Makefile) ```sh -cmake -H . -B build/ -DCMAKE_BUILD_TYPE=Release +cmake -B build/ -DCMAKE_BUILD_TYPE=Release . ``` | 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_TESTS | Build tests that check if the build results behave as they should | boolean | false | - | | 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 Example for **make**: ```sh -cd build/ -make +make -C build ``` You now should have the library built at `build/libuirc.so` *(or your build output path)*