README.md
1# Vulkan-Headers
2
3Vulkan header files and API registry
4
5This repository contains Vulkan header files, include files for C and C++,
6and related scripts and tests.
7
8Most of the files in this repository are sourced from, or generated from,
9other repositories as described in [CONTRIBUTING.md](CONTRIBUTING.md).
10Vulkan-Headers exists as a staging area for these files, most of which are
11then consumed by downstream repositories used to build SDK components such
12as the Vulkan Validation Layers and Conformance Test Suite.
13
14Developers normally obtain headers from the official
15[Vulkan-SDK](https://www.lunarg.com/vulkan-sdk/).
16They can also use headers from, or packaged from, this repository.
17
18In most cases, developers should only need the headers, not the scripts and
19other material in this repository.
20In particular if you are packaging the headers for inclusion in Linux
21distributions or similar uses, we advise that you do not include the
22scripts, and direct potential users of the scripts to their canonical
23sources in the [Vulkan Specification
24repository](https://github.com/KhronosGroup/Vulkan-Docs).
25
26## Contributing
27
28See the [CONTRIBUTING.md](CONTRIBUTING.md)
29
30## Building
31
32See [BUILD.md](BUILD.md)
33
34## SDK Support
35
36Vulkan-Headers are shipped as part of the official [Vulkan-SDK](https://www.lunarg.com/vulkan-sdk/)
37
38## C/C++ Package Manager Support
39
40`Vulkan-Headers` are also supported by both [conan](https://conan.io/) & [vcpkg](https://learn.microsoft.com/en-us/vcpkg/).
41
42## Version Tagging Scheme
43
44Updates to the `Vulkan-Headers` repository which correspond to a new Vulkan
45specification release are tagged using the following format:
46`v<`_`version`_`>` (e.g., `v1.3.255`).
47
48**Note**: Marked version releases have undergone thorough testing but do not
49imply the same quality level as SDK tags. SDK tags follow the
50`sdk-<`_`version`_`>.<`_`patch`_`>` format (e.g., `sdk-1.3.250.0`).
51