diff options
author | Mark Lobodzinski <mark@lunarg.com> | 2018-01-04 14:55:26 -0700 |
---|---|---|
committer | Mark Lobodzinski <mark@lunarg.com> | 2018-01-05 09:01:45 -0700 |
commit | 863defa6a38a0f13776ed05b07428a6e90004623 (patch) | |
tree | 3b287ecb10715a7fc07063d24386b46f3532c538 /README.md | |
parent | 48a6a705b976a244cf25188c857b0bff8b974d2e (diff) | |
download | vulkan-validation-layers-863defa6a38a0f13776ed05b07428a6e90004623.tar.gz |
docs: Add governance doc, Update readme, contributing
Change-Id: I92bebd8a33df564daff1b44633e79b56ffa6ae86
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 44 |
1 files changed, 19 insertions, 25 deletions
@@ -1,6 +1,6 @@ # Vulkan Ecosystem Components -This project provides Khronos official ICD loader and validation layers for Vulkan developers on Windows and Linux. +This project provides the Khronos official ICD loader and validation layers for Vulkan developers on Windows and Linux. ## CI Build Status | Platform | Build Status | @@ -11,32 +11,36 @@ This project provides Khronos official ICD loader and validation layers for Vulk ## Introduction -Vulkan is an Explicit API, enabling direct control over how GPUs actually work. No (or very little) validation -or error checking is done inside a Vulkan driver. Applications have full control and responsibility. Any errors in -how Vulkan is used often result in a crash. This project provides standard validation layers that can be enabled -to ease development by helping developers verify their applications correctly use the Vulkan API. +Vulkan is an Explicit API, enabling direct control over how GPUs actually work. By design, minimal error checking is done inside +a Vulkan driver. Applications have full control and responsibility for correct operation. Any errors in +how Vulkan is used can result in a crash. This project provides Vulkan validation layers that can be enabled +to assist development by enabling developers to verify their applications correct use of the Vulkan API. Vulkan supports multiple GPUs and multiple global contexts (VkInstance). The ICD loader is necessary to -support multiple GPUs and the VkInstance level Vulkan commands. Additionally, the loader manages inserting -Vulkan layer libraries, including validation layers between the application and the ICD. +support multiple GPUs and VkInstance-level Vulkan commands. Additionally, the loader manages inserting +Vulkan layer libraries such as validation layers between the application and the ICD. The following components are available in this repository: -- Vulkan header files +- [Vulkan header files](include/vulkan/) - [*ICD Loader*](loader/) - [*Validation Layers*](layers/) - [*Mock ICD*](icd/) -- Demos and tests for the loader and validation layers +- [*Demos*](demos/) +- [*Tests*](tests/) -## Contributing +## Contact Information +[Tobine Ehlis](mailto:tobine@google.com) +[Mark Lobodzinski](mailto:mark@lunarg.com) -If you intend to contribute, the preferred work flow is for you to develop your contribution -in a fork of this repo in your GitHub account and then submit a pull request. -Please see the [CONTRIBUTING](CONTRIBUTING.md) file in this repository for more details +## Information for Developing or Contributing: + +Please see the [CONTRIBUTING](CONTRIBUTING.md) file in this repository for more details. +Please see the [GOVERNANCE](GOVERNANCE.md) file in this repository for repository management details. ## How to Build and Run [BUILD.md](BUILD.md) -includes directions for building all the components, running the validation tests and running the demo applications. +Includes directions for building all components as well as running validation tests and demo applications. Information on how to enable the various Validation layers is in [layers/README.md](layers/README.md). @@ -44,23 +48,13 @@ Information on how to enable the various Validation layers is in Architecture and interface information for the loader is in [loader/LoaderAndLayerInterface.md](loader/LoaderAndLayerInterface.md). -#### **NOTE**: Update Nvidia Drivers -- A recent glslang change exposed a bug in the texel fetch behavior on Nvidia devices under certain situations. -- Previously, we reverted the glslang change which exposed it. -- Nvidia has since resolved the issue, and we are now removing the workaround. -- Driver installs with the fix are available on their download page, just look for: - - Linux Drivers starting with version 367.35 - - Windows Drivers starting at version 372.54 - ## License This work is released as open source under a Apache-style license from Khronos including a Khronos copyright. See COPYRIGHT.txt for a full list of licenses used in this repository. ## Acknowledgements -While this project has been developed primarily by LunarG, Inc; there are many other +While this project has been developed primarily by LunarG, Inc., there are many other companies and individuals making this possible: Valve Corporation, funding project development; Google providing significant contributions to the validation layers; Khronos providing oversight and hosting of the project. - - |