From e014248b3b053c8a4f448681a87771dec200d8cc Mon Sep 17 00:00:00 2001
From: Codotaku <88196711+CodesOtakuYT@users.noreply.github.com>
Date: Wed, 26 Jul 2023 15:36:21 +0100
Subject: [PATCH] Provide more info about vk.xml path

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 45cbff1..ff6f47f 100644
--- a/README.md
+++ b/README.md
@@ -20,9 +20,20 @@ vulkan-zig aims to be always compatible with the ever-changing Zig master branch
 ### CLI-interface
 A CLI-interface is provided to generate vk.zig from the [Vulkan XML registry](https://github.com/KhronosGroup/Vulkan-Docs/blob/main/xml), which is built by default when invoking `zig build` in the project root. To generate vk.zig, simply invoke the program as follows:
 ```
-$ zig-out/bin/vulkan-zig-generator path/to/vk.xml output/path/to/vk.zig
+$ 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:
+    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
 
 ### 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: