BUILDING.md
d143b7ee
 # Building
 
 This project supports [CMake][] and uses [`cmake-common`][]. There are several
 ways to use it in other CMake-based projects:
 
 -   With [`find_package`][]: ([Package][] and) [install][] it on the system.
 
 -   With [`add_subdirectory`][]: Bundle it.
 
 -   With [`FetchContent`][]: Download it as part of the CMake configure step.
 
 -   With [`cmake-common`][]: Use any of the above methods through a simplified
     interface.
 
 As usual, use [`add_dependencies`][] or [`target_link_libraries`][] (or
 `cmake-common`'s `DEPENDENCIES_*`) to declare the dependency.
 
 [CMake]: https://cmake.org
 [`cmake-common`]: https://git.rcrnstn.net/rcrnstn/cmake-common
 [`FetchContent`]: https://cmake.org/cmake/help/v3.14/module/FetchContent.html
 [`add_subdirectory`]: https://cmake.org/cmake/help/v3.14/command/add_subdirectory.html
 [`find_package`]: https://cmake.org/cmake/help/v3.14/command/find_package.html
 [Package]: #Package
 [Install]: #Install
 [`add_dependencies`]: https://cmake.org/cmake/help/v3.14/command/add_dependencies.html
 [`target_link_libraries`]: https://cmake.org/cmake/help/v3.14/command/target_link_libraries.html
 
 ## Configure and generate
 
 To configure and generate a build tree, use `cmake`:
 
 ```sh
 cmake -B _build
 ```
 
 To set the build type, pass e.g. `-D`[`CMAKE_BUILD_TYPE`][]`=Release`.
 
 To disable building tests, pass `-D`[`BUILD_TESTING`][]`=OFF`.
 
 [`cmake`]: https://cmake.org/cmake/help/v3.14/manual/cmake.1.html#generate-a-project-buildsystem
 [`CMAKE_BUILD_TYPE`]: https://cmake.org/cmake/help/v3.14/variable/CMAKE_BUILD_TYPE.html
 [`BUILD_TESTING`]: https://cmake.org/cmake/help/v3.14/module/CTest.html
 
 ## Build
 
 To build, use [`cmake --build`][]:
 
 ```sh
 cmake --build _build
 ```
 
 [`cmake --build`]: https://cmake.org/cmake/help/v3.14/manual/cmake.1.html#build-a-project
 
 ## Test
 
 To run tests, use [`ctest`][]:
 
 ```sh
 (cd _build && ctest)
 ```
 
 To show output from failing tests, pass `--output-on-failure`. To show output
 from all tests, pass `--verbose`.
 
 [`ctest`]: https://cmake.org/cmake/help/v3.14/manual/ctest.1.html
 
 ## Package
 
 To package, use [`cpack`][]:
 
 ```sh
 (cd _build && cpack)
 ```
 
 [`cpack`]: https://cmake.org/cmake/help/v3.14/manual/cpack.1.html
 
 ## Install
 
 To install onto the current system, use [`cmake --install`][]:
 
 ```sh
 cmake --install _build
 ```
 
 To set the prefix, pass e.g. `-D`[`CMAKE_INSTALL_PREFIX`][]`="$HOME/.local"`.
 
 [`cmake --install`]: https://cmake.org/cmake/help/v3.14/manual/cmake.1.html#install-a-project
 [`CMAKE_INSTALL_PREFIX`]: https://cmake.org/cmake/help/v3.14/variable/CMAKE_INSTALL_PREFIX.html