Skip to content

Commit 58c7fda

Browse files
authored
Update README.md
1 parent 0ef6c62 commit 58c7fda

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<a href="https://github.com/humbletim/setup-vulkan-sdk"><img alt="GitHub Actions status" src="https://github.com/humbletim/setup-vulkan-sdk/workflows/Setup/badge.svg"></a>
55
</p>
66

7-
This action builds a subset of the Vulkan SDK from source and makes it available to later build steps through an exported `VULKAN_SDK` environment variable.
7+
This action builds a subset of the Vulkan SDK from source and makes the results available to later build steps through a `VULKAN_SDK` environment variable.
88

99
*note: currently only x64 windows and x64 linux environments are supported (if you need another configuration added let me know)*
1010

@@ -34,6 +34,6 @@ To build against the latest Vulkan SDK:
3434

3535
First [action.yml](action.yml) installs the minimum dependencies needed to compile Vulkan SDK from source. It then delegates to [install_vulkan_sdk.sh](install_vulkan_sdk.sh), which resolves `vulkan-version` into a corresponding git branch using the official Vulkan SDK [web services](https://vulkan.lunarg.com/content/view/latest-sdk-version-api).
3636

37-
[KhronosGroup/Vulkan-Headers](https://github.com/KhronosGroup/Vulkan-Headers) and [KhronosGroup/Vulkan-Loader](https://github.com/KhronosGroup/Vulkan-Loader) repos are then cloned locally to that branch point, built, and installed into `$PWD/VULKAN_SDK`. And finally a `VULKAN_SDK` environment variable is exported for later build tools to discover to SDK's location through.
37+
[KhronosGroup/Vulkan-Headers](https://github.com/KhronosGroup/Vulkan-Headers) and [KhronosGroup/Vulkan-Loader](https://github.com/KhronosGroup/Vulkan-Loader) repos are then cloned locally to that branch point, built, and installed into `$PWD/VULKAN_SDK`. And finally a `VULKAN_SDK` environment variable is exported for later build tools to discover the SDK's location through.
3838

3939
The entire process takes around a minute or so to complete and the installed artifacts consume around a dozen megabytes of storage space (as opposed to the 1GB+ required for a full Vulkan SDK prebuilt install). Note that this approach only provides enough to compile and link Vulkan applications against -- it _does not_ provide the other utilities, documentation, or code samples that normally ship with the [Full Vulkan SDK](https://www.lunarg.com/vulkan-sdk/).

0 commit comments

Comments
 (0)