docs: Add explanation of version tagging scheme
authorShannon McPherson <shannon@lunarg.com>
Tue, 18 Dec 2018 18:17:18 +0000 (11:17 -0700)
committerShannon McPherson <shannon@lunarg.com>
Wed, 19 Dec 2018 00:56:19 +0000 (17:56 -0700)
Change-Id: I8a83d5e2303d09fe22425cb350473262694f4642

README.md

index 7cdd182..3dd2858 100644 (file)
--- 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.