mirror of
https://github.com/KhronosGroup/Vulkan-Headers
synced 2024-11-21 06:26:00 -07:00
docs: Re-add documentation
This commit is contained in:
parent
78448eda6e
commit
4f1c41662f
2 changed files with 18 additions and 0 deletions
|
@ -2,6 +2,8 @@
|
|||
|
||||
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) or [Vulkan-Hpp](https://github.com/KhronosGroup/Vulkan-Hpp)
|
||||
|
||||
### This repository (https://github.com/KhronosGroup/Vulkan-Headers)
|
||||
|
||||
* BUILD.gn
|
||||
|
@ -26,4 +28,8 @@ Please note when contributing what files this repository actually is responsible
|
|||
|
||||
### 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
|
||||
|
|
12
README.md
12
README.md
|
@ -24,3 +24,15 @@ Vulkan-Headers are shipped as part of the official [Vulkan-SDK](https://www.luna
|
|||
## C/C++ Package Manager Support
|
||||
|
||||
`Vulkan-Headers` are also supported by both [conan](https://conan.io/) & [vcpkg](https://learn.microsoft.com/en-us/vcpkg/).
|
||||
|
||||
## 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.
|
||||
|
|
Loading…
Reference in a new issue