mewin/vulkan-headers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

cmake: Update BUILD.md documentation

Browse Source
This commit is contained in:
Juan Ramos 2022-11-07 14:07:45 -07:00 committed by Juan Ramos
parent e55c3116c1
commit ef96d229cb
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
BUILD.md
View File

@ -39,12 +39,26 @@ indicated by *install_dir*:
- *install_dir*`/include/vulkan` : The header files found in the - *install_dir*`/include/vulkan` : The header files found in the
`include/vulkan` directory of this repository `include/vulkan` directory of this repository
- *install_dir*`/share/cmake/VulkanHeaders`: The CMake config files needed
for find_package support
- *install_dir*`/share/vulkan/registry` : The registry files found in the - *install_dir*`/share/vulkan/registry` : The registry files found in the
`registry` directory of this repository `registry` directory of this repository
The `uninstall` target can be used to remove the above files from the install The `uninstall` target can be used to remove the above files from the install
directory. directory.
### Usage in CMake
The library provides a Config file for CMake, once installed it can be found via `find_package`.
Which, when successful, will add library target called `Vulkan::Headers` which you can use via the usual `target_link_libraries` mechanism.
```cmake
find_package(VulkanHeaders REQUIRED CONFIG)
target_link_libraries(foobar PRIVATE Vulkan::Headers)
```
## Repository Set-Up ## Repository Set-Up
### Download the Repository ### Download the Repository