vulkaninfo: update readme for Windows SDK name change
authorCharles Giessen <charles@lunarg.com>
Fri, 17 Jan 2020 18:11:32 +0000 (11:11 -0700)
committerCharles Giessen <46324611+charles-lunarg@users.noreply.github.com>
Fri, 17 Jan 2020 18:49:40 +0000 (11:49 -0700)
Due to IVH's shipping their own version of vulkaninfo through
the vulkan runtime package, the vulkaninfo binary included in the
Windows Vulkan SDK was renamed to `vulkaninfoSDK.exe` to prevent
name conflicts. This commit fixes the lack of documentation in the
readme about the change

Changes to be committed:
modified:   vulkaninfo/vulkaninfo.md

Change-Id: I7533eaa4ee5a915b36324f40a9ba4ced785710ff

vulkaninfo/vulkaninfo.md

index 4825596..396d77a 100644 (file)
@@ -72,3 +72,5 @@ Vulkan Info can also be found as a shortcut under the Start Menu.
 * `Start Menu -> Vulkan SDK`*`version`*`-> vulkaninfo`
 
 Note: In order to review and/or save the output produced when using Visual Studio execute `vulkaninfo` with the JSON option, you will have to redirect output to a file by modifying the command line arguments in the debug options.
+
+Note: The Vulkan Info binary found in the Vulkan SDK is renamed to `vulkaninfoSDK.exe`. This was done to demark any Vulkan Info version installed by the Vulkan Runtime Package, which is from an IHV distribution. When using command line on Windows, the Vulkan info version used will be from the IHV distribution, not the SDK. To run the SDK version, either use the start menu shortcuts or navigate to the `VulkanSDK/Bin` directory and run `vulkaninfoSDK.exe` directly.