summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJuan Ramos <[email protected]>2022-11-07 14:07:45 -0700
committerJuan Ramos <[email protected]>2022-11-08 10:22:11 -0700
commitef96d229cb3d9d58b71c832aafd79f9dda306375 (patch)
treed25ae744439f09cf7d398df35afb70953f069c70
parente55c3116c119b594851e8a5289319a6305544a92 (diff)
downloadVulkan-Headers-ef96d229cb3d9d58b71c832aafd79f9dda306375.tar.gz
Vulkan-Headers-ef96d229cb3d9d58b71c832aafd79f9dda306375.zip
cmake: Update BUILD.md documentation
-rw-r--r--BUILD.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/BUILD.md b/BUILD.md
index 1188134..7555470 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -39,12 +39,26 @@ indicated by *install_dir*:
- *install_dir*`/include/vulkan` : The header files found in the
`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
`registry` directory of this repository
The `uninstall` target can be used to remove the above files from the install
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
### Download the Repository