Building `libbase`

Prerequisites

Attention

Ensure you have all prerequisites installed and configured. See Prerequisites for more details.

Obtaining the source code

The recommended way to obtain the source code is:

$ git clone https://github.com/RippeR37/libbase.git

You can pass an additional --depth <depth> argument to limit the repository history to be downloaded (e.g. --depth 1).

Resolving libbase dependencies

Before configuring and building libbase you either have to build and install them yourself or configure vcpkg and set VCPKG_ROOT environment variable so that libbase CMake script can find and use it to resolve dependencies automatically.

Building with CMake

$ cd libbase
$ cmake -S . -B build
$ cmake --build build

This will configure libbase with the default configuration options and build it in the build/ subdirectory.

Running the tests

If you’ve built the library with unit tests (see Configuration options), you can run them all with:

$ ctest --test-dir build

Configuration

You can configure libbase build or library itself by overriding default options defined in CMake scripts. You can do this by specifying the -DOPTION_NAME=[ON/OFF] switch for a given option during CMake configuration phase. For example, to build libbase with the documentation, you would have to execute:

$ cmake -DLIBBASE_BUILD_DOCS=ON -S . -B build
$ cmake --build build

Building libbase