diff options
| author | Jon Leech <[email protected]> | 2023-06-26 03:47:21 -0700 |
|---|---|---|
| committer | Jon Leech <[email protected]> | 2023-06-26 17:03:30 -0700 |
| commit | 9b834aa4436b880a43e0bcc8cd8161d2906929e7 (patch) | |
| tree | cfdaffac041c7afcf512e85e83e83a7417289c34 | |
| parent | b6a29e5ca865f48368f6b2f170adb89975bb0be1 (diff) | |
| download | Vulkan-Headers-9b834aa4436b880a43e0bcc8cd8161d2906929e7.tar.gz Vulkan-Headers-9b834aa4436b880a43e0bcc8cd8161d2906929e7.zip | |
Update README to be more clear about use of the different files in the repo
This is intended to clarify that developers using Vulkan are likely to
need only the header files, not the scripts and other material in the
repository which are used by the SDK and other downstream ecosystem
components.
Closes #407
| -rw-r--r-- | README.md | 25 |
1 files changed, 23 insertions, 2 deletions
@@ -2,6 +2,27 @@ Vulkan header files and API registry +This repository contains Vulkan header files, include files for C and C++, +and related scripts and tests. + +Most of the files in this repository are sourced from, or generated from, +other repositories as described in [CONTRIBUTING.md](CONTRIBUTING.md). +Vulkan-Headers exists as a staging area for these files, most of which are +then consumed by downstream repositories used to build SDK components such +as the Vulkan Validation Layers and Conformance Test Suite. + +Developers normally obtain headers from the official +[Vulkan-SDK](https://www.lunarg.com/vulkan-sdk/). +They can also use headers from, or packaged from, this repository. + +In most cases, developers should only need the headers, not the scripts and +other material in this repository. +In particular if you are packaging the headers for inclusion in Linux +distributions or similar uses, we advise that you do not include the +scripts, and direct potential users of the scripts to their canonical +sources in the [Vulkan Specification +repository](https://github.com/KhronosGroup/Vulkan-Docs). + ## Contributing See the [CONTRIBUTING.md](CONTRIBUTING.md) @@ -22,8 +43,8 @@ Vulkan-Headers are shipped as part of the official [Vulkan-SDK](https://www.luna Updates to the `Vulkan-Headers` repository which correspond to a new Vulkan specification release are tagged using the following format: -`v<`_`version`_`>` (e.g., `v1.1.96`). +`v<`_`version`_`>` (e.g., `v1.3.255`). **Note**: Marked version releases have undergone thorough testing but do not imply the same quality level as SDK tags. SDK tags follow the -`sdk-<`_`version`_`>.<`_`patch`_`>` format (e.g., `sdk-1.1.92.0`). +`sdk-<`_`version`_`>.<`_`patch`_`>` format (e.g., `sdk-1.3.250.0`). |