gil/example/cmake/README.md

1.7 KiB

CMake Configuration Examples

Examples of configuration files for CMake integrations in popular IDEs are provided for convenience of users and contributors who wish to build, run and debug Boost.GIL tests and examples in the IDEs of their choice.

Visual Studio

Example CMakeSettings.json file is provided for the CMake support in Visual Studio.

Currently, the CMakeSettings.json provides configurations for the following CMake generators:

  • Ninja (default)
  • Visual Studio 2017 and 2019
  • Unix Makefiles targeting Windows Subsystem for Linux (WSL) - requires Visual Studio 2019 IDE.

Usage:

  1. Copy CMakeSettings.json to ${BOOST_ROOT}/libs/gil.
  2. In Visual Studio > File > Open > Folder... and select ${BOOST_ROOT}/libs/gil.
  3. Follow the CMake support in Visual Studio documentation.
  4. CMakeSettings.json schema reference to learn more about the configuration file itself.

Optionally, edit CMakeSettings.json and tweak any options you require.

Visual Studio Code

Example of cmake-variants.yaml file is provided for the CMake Tools extension.

Usage:

  1. Copy cmake-variants.yaml to ${BOOST_ROOT}/libs/gil.
  2. Run code ${BOOST_ROOT}/libs/gil and the set of variants will be loaded.
  3. Follow the CMake Tools documentation.

Optionally, edit cmake-variants.yamland tweak any options you require.