diff --git a/README.md b/README.md index ff6f47f..5972c1a 100644 --- a/README.md +++ b/README.md @@ -23,17 +23,13 @@ A CLI-interface is provided to generate vk.zig from the [Vulkan XML registry](ht $ zig-out/bin/generator path/to/vk.xml output/path/to/vk.zig ``` This reads the xml file, parses its contents, renders the Vulkan bindings, and formats file, before writing the result to the output path. While the intended usage of vulkan-zig is through direct generation from build.zig (see below), the CLI-interface can be used for one-off generation and vendoring the result. -NOTE: you need to replace `path/to/vk.xml` with the spec path from whatever source you prefer, here are some example orderered from the most recommended: -- Vulkan-Headers repo: +NOTE: you need to replace `path/to/vk.xml` with the spec path from whatever source you prefer, here are some examples orderered from the most recommended: +- Vulkan SDK, you need the package installed on your system with environment path setup but its the most stable option: + /share/vulkan/registry/vk.xml +- Vulkan-Headers repo, doesn't require the Vulkan SDK in the build environment: https://github.com/KhronosGroup/Vulkan-Headers/blob/main/registry/vk.xml -- Vulkan SDK (you need the package installed on your system with environment path setup): - Windows: - Powershell: ${env:VULKAN_SDK}/share/vulkan/registry - Cmd: %VULKAN_SDL%/share/vulkan/registry - Linux: - /usr/share/vulkan/registry/vk.xml - local vk.xml inside examples: - vulkan-zig\examples\vk.xml + vulkan-zig\examples\vk.xml ### Generation from build.zig Vulkan bindings can be generated from the Vulkan XML registry at compile time with build.zig, by using the provided Vulkan generation step: