summaryrefslogtreecommitdiff
path: root/external/vulkan/README.md
diff options
context:
space:
mode:
authorjsmall-nvidia <jsmall@nvidia.com>2019-03-15 17:26:27 -0400
committerGitHub <noreply@github.com>2019-03-15 17:26:27 -0400
commit1bc99cf725e1fcaf542a61fc786be18e18173003 (patch)
tree6bdf5754d210ded6b578bb9919f99e4d3a958207 /external/vulkan/README.md
parentc8e36bd128a29654b2ec145038da9e132330581b (diff)
Upgraded vulkan headers to v1.1.103 (#909)
https://github.com/KhronosGroup/Vulkan-Headers
Diffstat (limited to 'external/vulkan/README.md')
-rw-r--r--external/vulkan/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/external/vulkan/README.md b/external/vulkan/README.md
new file mode 100644
index 000000000..685e712d1
--- /dev/null
+++ b/external/vulkan/README.md
@@ -0,0 +1,26 @@
+# Vulkan-Headers
+
+Vulkan header files and API registry
+
+## Repository Content
+
+The contents of this repository are largely obtained from other repositories and are
+collected, coordinated, and curated here.
+
+The projects for these repositories are:
+
+- [KhronosGroup/Vulkan-Docs](https://github.com/KhronosGroup/Vulkan-Docs)
+ - Core Vulkan headers and Registry
+- [KhronosGroup/Vulkan-Hpp](https://github.com/KhronosGroup/Vulkan-Hpp)
+ - C++ Bindings for Vulkan
+
+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.