summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJuan Ramos <[email protected]>2023-01-12 12:36:51 -0700
committerJuan Ramos <[email protected]>2023-01-12 12:43:25 -0700
commit460f75b518b603472a465bed7083b7864633c3a0 (patch)
tree7dd022ae750aa7604b24dbcf265f0d67ae2e80a4
parent50f8b24b8530ed9eec00367d7b19af777ae1f6c0 (diff)
downloadVulkan-Headers-460f75b518b603472a465bed7083b7864633c3a0.tar.gz
Vulkan-Headers-460f75b518b603472a465bed7083b7864633c3a0.zip
docs: Add CONTRIBUTING.md
-rw-r--r--CONTRIBUTING.md36
-rw-r--r--README.md33
2 files changed, 39 insertions, 30 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..e4d96bc
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,36 @@
+# CONTRIBUTING
+
+Please note when contributing what files this repository actually is responsible for.
+
+The majority for the Vulkan headers come from [Vulkan-Docs](https://github.com/KhronosGroup/Vulkan-Docs)
+
+### This repository (https://github.com/KhronosGroup/Vulkan-Headers)
+
+* BUILD.gn
+* BUILD.md
+* cmake/
+* CMakeLists.txt
+* tests/*
+* CODE_OF_CONDUCT.md
+* INTEGRATION.md
+* LICENSE.txt
+* README.md
+* Non-API headers
+ * include/vulkan/vk_icd.h
+ * include/vulkan/vk_layer.h
+ * include/vulkan/vk_sdk_platform.h (deprecated)
+
+### Specification repository (https://github.com/KhronosGroup/Vulkan-Docs)
+
+* registry/*.py
+* registry/spec_tools/*.py
+* registry/profiles/*.json
+* All files under include/vulkan/ which are *not* listed explicitly as originating from another repository.
+
+### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp)
+
+As of the Vulkan-Docs 1.2.182 spec update, the Vulkan-Hpp headers have been
+split into multiple files. All of those files are now included in this
+repository.
+
+* include/vulkan/*.hpp
diff --git a/README.md b/README.md
index 5a08f3b..00dd4e1 100644
--- a/README.md
+++ b/README.md
@@ -9,36 +9,9 @@ If proposing changes to any file originating from a different repository,
please propose such changes in that repository, rather than Vulkan-Headers.
Files in this repository originate from:
-### Specification repository (https://github.com/KhronosGroup/Vulkan-Docs)
-
-* registry/*.py
-* registry/spec_tools/*.py
-* registry/profiles/*.json
-* All files under include/vulkan/ which are *not* listed explicitly as originating from another repository.
-
-### This repository (https://github.com/KhronosGroup/Vulkan-Headers)
-
-* BUILD.gn
-* BUILD.md
-* cmake/
-* CMakeLists.txt
-* tests/*
-* CODE_OF_CONDUCT.md
-* INTEGRATION.md
-* LICENSE.txt
-* README.md
-* Non-API headers
- * include/vulkan/vk_icd.h
- * include/vulkan/vk_layer.h
- * include/vulkan/vk_sdk_platform.h
-
-### Vulkan C++ Binding Repository (https://github.com/KhronosGroup/Vulkan-Hpp)
-
-As of the Vulkan-Docs 1.2.182 spec update, the Vulkan-Hpp headers have been
-split into multiple files. All of those files are now included in this
-repository.
-
-* include/vulkan/*.hpp
+## Contributing
+
+See the [CONTRIBUTING.md](CONTRIBUTING.md)
## Version Tagging Scheme