summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorJon Leech <[email protected]>2019-07-30 05:03:32 -0700
committerJon Leech <[email protected]>2019-07-30 05:03:32 -0700
commit7f6a212a139dbb63a0aab32254072196d1769e15 (patch)
treeda036a968ddc10af3f55341557ebc019141cfd4f /README.md
parentfd568d51ed3d9bc6132e1639d7492453a08fe1bc (diff)
downloadVulkan-Headers-7f6a212a139dbb63a0aab32254072196d1769e15.tar.gz
Vulkan-Headers-7f6a212a139dbb63a0aab32254072196d1769e15.zip
Update to try and prevent inappropriate PRs from being submitted against this repo
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 685e712..4687289 100644
--- a/README.md
+++ b/README.md
@@ -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.