diff options
| -rw-r--r-- | CONTRIBUTING.md | 36 | ||||
| -rw-r--r-- | README.md | 33 |
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 @@ -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 |