diff --git a/README.md b/README.md index b926cbc..9e433d4 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ Developement mainly takes place on our in-house `gitlab` instance. However, we p ### Adding `warpcore` to a CMake Project `warpcore` is designed to make it easy to include within another CMake project. - The `CMakeLists.txt` exports a `warpcore` target that can be linked into a target to setup include directories, dependencies, and compile flags necessary to use `warpcore` in your project. + The `CMakeLists.txt` exports a `warpcore` target that can be linked[1](#link-footnote) into a target to setup include directories, dependencies, and compile flags necessary to use `warpcore` in your project. We recommend using [CMake Package Manager (CPM)](https://github.com/TheLartians/CPM.cmake) to fetch `warpcore` into your project. @@ -65,6 +65,25 @@ This will take care of downloading `warpcore` from GitHub and making the headers 1: `warpcore` is header-only and therefore there is no binary component to "link" against. The linking terminology comes from CMake's `target_link_libraries` which is still used even for header-only library targets. +## Building `warpcore` + +Since `warpcore` is header-only, there is nothing to build to use it. + +To build the tests, benchmarks, and examples: + +``` +cd $WARPCORE_ROOT +mkdir -p build +cd build +cmake .. -DWARPCORE_BUILD_TESTS=ON -DDWARPCORE_BUILD_BENCHMARKS=ON -DDWARPCORE_BUILD_EXAMPLES=ON +make +``` +Binaries will be built into: +- `build/tests/` +- `build/benchmarks/` +- `build/examples/` + + ## [Documentation](docs/index.html) ## Where to go from here?