docs: Add explanation of version tagging scheme

This commit is contained in:
Shannon McPherson 2018-12-17 14:56:30 -07:00
parent 084c2624ee
commit f54e45b923

View file

@ -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.