aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorShannon McPherson <[email protected]>2018-12-17 14:56:30 -0700
committerShannon McPherson <[email protected]>2018-12-17 15:29:33 -0700
commitf54e45b92374b99de8556cacffc3602a03187b68 (patch)
treee17892fb7cc02c27607cb6f6709b53a35ed06f4a /README.md
parent084c2624eed5ed59e33752ecf1205de63263ec9c (diff)
downloadVulkan-Headers-f54e45b92374b99de8556cacffc3602a03187b68.tar.gz
Vulkan-Headers-f54e45b92374b99de8556cacffc3602a03187b68.zip
docs: Add explanation of version tagging schemev1.1.96
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/README.md b/README.md
index 4744317..685e712 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Vulkan-Headers
-Vulkan Header files and API registry
+Vulkan header files and API registry
## Repository Content
@@ -16,3 +16,11 @@ The projects for these repositories are:
Please visit the appropriate project in the above list for obtaining additional information,
asking questions, or opening issues.
+
+## 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.