From c0f97e598d0eba3a5d241df8602db01801442b32 Mon Sep 17 00:00:00 2001 From: Russ Taylor Date: Wed, 2 Aug 2023 13:35:57 -0400 Subject: [PATCH] doc: Clarify Vulkan SDK requirement on Windows in README.md file. --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e48d12c9a..e9d665c8a 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,11 @@ best with the following vcpkg packages installed: If you have a recent [vcpkg](https://vcpkg.io) installed and use the appropriate CMake toolchain file, the vcpkg manifest in the Monado repository will instruct -vcpkg to locally install the dependencies automatically. +vcpkg to locally install the dependencies automatically. The Vulkan SDK +installer should set the `VULKAN_SDK` Windows environment variable to point +at the installation location (for example, `C:/VulkanSDK/1.3.250.1`), though +make sure you open a new terminal (or open the CMake GUI) *after* doing that +install to make sure it is available. Monado has been tested on these distributions, but is expected to work on almost any modern distribution.