aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShannon McPherson <shannon@lunarg.com>2018-12-18 11:17:18 -0700
committerShannon McPherson <shannon@lunarg.com>2018-12-18 17:56:19 -0700
commit85ba793e025e381bfcc7988265cd472cd45e4396 (patch)
tree2f1346df8e2750be17a007c5e6bfa8d35d925c37
parent9d4727c6a05ce07e1f401a2e01908da4a258df53 (diff)
downloadusermoji-85ba793e025e381bfcc7988265cd472cd45e4396.tar.xz
docs: Add explanation of version tagging scheme
Change-Id: I8a83d5e2303d09fe22425cb350473262694f4642
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7cdd182c..3dd28580 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,14 @@ Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for reposi
[BUILD.md](BUILD.md)
Includes directions for building all components as well as running the vkcube demo applications.
+## Version Tagging Scheme
+
+Updates to the `Vulkan-Tools` 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.
+
## License
This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.