Skip to content

BUILDING.md

Latest commit

 

History

History
58 lines (40 loc) · 1.78 KB

BUILDING.md

File metadata and controls

58 lines (40 loc) · 1.78 KB
Raw

Building with CMake

Dependencies

For a list of dependencies, please refer to vcpkg.json.

Build

Building requires that vcpkg is installed and available as toolchain for CMake. The project includes CMake presets that uses the vcpkg toolchain found in $VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake.

Here are the steps for building in release mode with a single-configuration generator, like the Unix Makefiles one:

cmake -S . -B build -D CMAKE_BUILD_TYPE=Release -E <preset>
cmake --build build

Here are the steps for building in release mode with a multi-configuration generator, like the Visual Studio ones:

cmake -S . -B build -E <preset>
cmake --build build --config Release

Building with MSVC

Note that MSVC by default is not standards compliant and you need to pass some flags to make it behave properly. See the flags-msvc preset in the CMakePresets.json file for the flags and with what variable to provide them to CMake during configuration.

Install

This project doesn't require any special command-line flags to install to keep things simple. As a prerequisite, the project has to be built with the above commands already.

The below commands require at least CMake 3.15 to run, because that is the version in which Install a Project was added.

Here is the command for installing the release mode artifacts with a single-configuration generator, like the Unix Makefiles one:

cmake --install build

Here is the command for installing the release mode artifacts with a multi-configuration generator, like the Visual Studio ones:

cmake --install build --config Release