display

Layout and Rendering TUI library

git clone git://git.dimitrijedobrota.com/display.git

BUILDING.md (2666B)

1 # Building with CMake 2 3 ## Dependencies 4 5 For a list of dependencies, please refer to [vcpkg.json](vcpkg.json). 6 7 ## Build 8 9 This project doesn't require any special command-line flags to build to keep 10 things simple. 11 12 Here are the steps for building in release mode with a single-configuration 13 generator, like the Unix Makefiles one: 14 15 ```sh 16 cmake -S . -B build -D CMAKE_BUILD_TYPE=Release 17 cmake --build build 18 ``` 19 20 Here are the steps for building in release mode with a multi-configuration 21 generator, like the Visual Studio ones: 22 23 ```sh 24 cmake -S . -B build 25 cmake --build build --config Release 26 ``` 27 28 ### Building with MSVC 29 30 Note that MSVC by default is not standards compliant and you need to pass some 31 flags to make it behave properly. See the `flags-msvc` preset in the 32 [CMakePresets.json](CMakePresets.json) file for the flags and with what 33 variable to provide them to CMake during configuration. 34 35 ### Building on Apple Silicon 36 37 CMake supports building on Apple Silicon properly since 3.20.1. Make sure you 38 have the [latest version][1] installed. 39 40 ## Install 41 42 This project doesn't require any special command-line flags to install to keep 43 things simple. As a prerequisite, the project has to be built with the above 44 commands already. 45 46 The below commands require at least CMake 3.15 to run, because that is the 47 version in which [Install a Project][2] was added. 48 49 Here is the command for installing the release mode artifacts with a 50 single-configuration generator, like the Unix Makefiles one: 51 52 ```sh 53 cmake --install build 54 ``` 55 56 Here is the command for installing the release mode artifacts with a 57 multi-configuration generator, like the Visual Studio ones: 58 59 ```sh 60 cmake --install build --config Release 61 ``` 62 63 ### CMake package 64 65 This project exports a CMake package to be used with the [`find_package`][3] 66 command of CMake: 67 68 * Package name: `display` 69 * Target name: `display::display` 70 71 Example usage: 72 73 ```cmake 74 find_package(display REQUIRED) 75 # Declare the imported target as a build requirement using PRIVATE, where 76 # project_target is a target created in the consuming project 77 target_link_libraries( 78 project_target PRIVATE 79 display::display 80 ) 81 ``` 82 83 ### Note to packagers 84 85 The `CMAKE_INSTALL_INCLUDEDIR` is set to a path other than just `include` if 86 the project is configured as a top level project to avoid indirectly including 87 other libraries when installed to a common prefix. Please review the 88 [install-rules.cmake](cmake/install-rules.cmake) file for the full set of 89 install rules. 90 91 [1]: https://cmake.org/download/ 92 [2]: https://cmake.org/cmake/help/latest/manual/cmake.1.html#install-a-project 93 [3]: https://cmake.org/cmake/help/latest/command/find_package.html