diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 11 insertions, 2 deletions
@@ -7,6 +7,11 @@ Vulkan header files and API registry The contents of this repository are largely obtained from other repositories and are collected, coordinated, and curated here. +Do not propose pull requests to this repository which modify any files under +include/vulkan/ or registry/. All such files are generated from the +Vulkan-Docs repository and, in the case of include/vulkan/vulkan.hpp, the +Vulkan-Hpp repository. Any changes must be made in those repositories. + The projects for these repositories are: - [KhronosGroup/Vulkan-Docs](https://github.com/KhronosGroup/Vulkan-Docs) @@ -19,8 +24,12 @@ 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`). +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`). +**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. |