ceph/src/boost/libs/gil/example/cmake/README.md

   1 # CMake Configuration Examples
   2
   3 Examples of configuration files for CMake integrations in popular IDEs are provided
   4 for convenience of users and contributors who wish to build, run and debug
   5 Boost.GIL tests and examples in the IDEs of their choice.
   6
   7 ## Visual Studio
   8
   9 Example [CMakeSettings.json](CMakeSettings.json) file is provided for
  10 the [CMake support in Visual Studio](https://go.microsoft.com//fwlink//?linkid=834763).
  11
  12 Currently, the `CMakeSettings.json` provides configurations for the following
  13 CMake generators:
  14 - Ninja (default)
  15 - Visual Studio 2017 and 2019
  16 - `Unix Makefiles` targeting Windows Subsystem for Linux (WSL) - requires Visual Studio 2019 IDE.
  17
  18 Usage:
  19
  20 1. Copy [CMakeSettings.json](CMakeSettings.json) to `${BOOST_ROOT}/libs/gil`.
  21 2. In Visual Studio > File > Open > Folder... and select `${BOOST_ROOT}/libs/gil`.
  22 3. Follow the [CMake support in Visual Studio](https://go.microsoft.com//fwlink//?linkid=834763) documentation.
  23 4. [CMakeSettings.json schema reference](https://docs.microsoft.com/en-us/cpp/build/cmakesettings-reference?view=vs-2017)
  24    to learn more about the configuration file itself.
  25
  26 Optionally, edit [CMakeSettings.json](CMakeSettings.json) and tweak any options you require.
  27
  28 ## Visual Studio Code
  29
  30 Example of [cmake-variants.yaml](cmake-variants.yaml) file is provided for
  31 the [CMake Tools](https://github.com/vector-of-bool/vscode-cmake-tools) extension.
  32
  33 Usage:
  34
  35 1. Copy [cmake-variants.yaml](cmake-variants.yaml) to `${BOOST_ROOT}/libs/gil`.
  36 2. Run `code ${BOOST_ROOT}/libs/gil` and the set of variants will be loaded.
  37 3. Follow the [CMake Tools documentation](https://vector-of-bool.github.io/docs/vscode-cmake-tools/index.html).
  38
  39 Optionally, edit [cmake-variants.yaml](cmake-variants.yaml)and tweak any options you require.