README.md
1# Vulkan Ecosystem Components
2
3This project provides the Khronos official Vulkan validation layers for Windows, Linux, Android, and MacOS.
4
5## CI Build Status
6| Platform | Build Status |
7|:--------:|:------------:|
8| Linux/Android | [](https://travis-ci.org/KhronosGroup/Vulkan-ValidationLayers) |
9| Windows |[](https://ci.appveyor.com/project/Khronoswebmaster/vulkan-validationlayers/branch/master) |
10
11
12## Introduction
13
14Vulkan is an Explicit API, enabling direct control over how GPUs actually work. By design, minimal error checking is done inside
15a Vulkan driver. Applications have full control and responsibility for correct operation. Any errors in
16how Vulkan is used can result in a crash. This project provides Vulkan validation layers that can be enabled
17to assist development by enabling developers to verify their applications correct use of the Vulkan API.
18
19The following components are available in this repository:
20- [*Validation Layers*](layers/)
21- [*Tests*](tests/)
22
23## Contact Information
24* [Tobin Ehlis](mailto:tobine@google.com)
25* [Mark Lobodzinski](mailto:mark@lunarg.com)
26
27## Information for Developing or Contributing:
28
29Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
30Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for repository management details.
31
32## How to Build and Run
33
34[BUILD.md](BUILD.md)
35Includes directions for building all components as well as running validation tests.
36
37Information on how to enable the various Validation layers is in
38[layers/README.md](layers/README.md).
39
40## Version Tagging Scheme
41
42Updates to the `Vulkan-ValidationLayers` repository which correspond to a new Vulkan specification release are tagged using the following format: `v<`_`version`_`>` (e.g., `v1.1.96`).
43
44**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`).
45
46This scheme was adopted following the 1.1.96 Vulkan specification release.
47
48## License
49This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.
50
51See COPYRIGHT.txt for a full list of licenses used in this repository.
52
53## Acknowledgements
54While this project has been developed primarily by LunarG, Inc., there are many other
55companies and individuals making this possible: Valve Corporation, funding
56project development; Google providing significant contributions to the validation layers;
57Khronos providing oversight and hosting of the project.
58
){kind=link}