summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJuan Ramos <[email protected]>2023-01-20 10:13:44 -0700
committerJuan Ramos <[email protected]>2023-01-20 10:14:54 -0700
commit4f1c41662f829f1ed3edea1b1a3d546caae6be25 (patch)
treef33080088701ee0b217d348d20da6de5555b64b9
parent78448eda6ed5911c6828d5305ae750e3aab65d15 (diff)
downloadVulkan-Headers-4f1c41662f829f1ed3edea1b1a3d546caae6be25.tar.gz
Vulkan-Headers-4f1c41662f829f1ed3edea1b1a3d546caae6be25.zip
docs: Re-add documentation
-rw-r--r--CONTRIBUTING.md6
-rw-r--r--README.md12
2 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 45217a7..bed4271 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,6 +2,8 @@
Please note when contributing what files this repository actually is responsible for.
+The majority for the Vulkan headers come from [Vulkan-Docs](https://github.com/KhronosGroup/Vulkan-Docs) or [Vulkan-Hpp](https://github.com/KhronosGroup/Vulkan-Hpp)
+
### This repository (https://github.com/KhronosGroup/Vulkan-Headers)
* BUILD.gn
@@ -26,4 +28,8 @@ Please note when contributing what files this repository actually is responsible
### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp)
+As of the Vulkan-Docs 1.2.182 spec update, the Vulkan-Hpp headers have been
+split into multiple files. All of those files are now included in this
+repository.
+
* include/vulkan/*.hpp
diff --git a/README.md b/README.md
index 02e42aa..685d802 100644
--- a/README.md
+++ b/README.md
@@ -24,3 +24,15 @@ Vulkan-Headers are shipped as part of the official [Vulkan-SDK](https://www.luna
## C/C++ Package Manager Support
`Vulkan-Headers` are also supported by both [conan](https://conan.io/) & [vcpkg](https://learn.microsoft.com/en-us/vcpkg/).
+
+## Version Tagging Scheme
+
+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`).
+
+**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`).
+
+This scheme was adopted following the 1.1.96 Vulkan specification release.