Update BUILD.md and README.md for the reduced scope of this repo
[platform/upstream/Vulkan-Tools.git] / README.md
1 # Vulkan Ecosystem Components\r
2 *Version 1.0, January 25, 2016*\r
3 \r
4 This project provides loader and validation layers for Vulkan developers on Windows and Linux.\r
5 \r
6 ## Introduction\r
7 \r
8 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 VK driver. Applications have full control and responsibility. Any errors in how VK is used are likely to result in a crash. This project provides layered utility libraries to ease development and help guide developers to proven safe patterns.\r
9 \r
10 New with Vulkan is an extensible layered architecture that enables validation libraries to be implemented as layers. The loader is essential in supporting multiple drivers and GPUs along with layer library enablement.\r
11 \r
12 The following components are available in this repository:\r
13 - Vulkan header files\r
14 - [*ICD Loader*](loader) and [*Layer Manager*](layers/README.md, loader/README.md\r
15 - Core [*Validation Layers*](layers/)\r
16 - Demos and tests for the loader and validation layers\r
17 \r
18 \r
19 ## How to Build and Run\r
20 \r
21 [BUILD.md](BUILD.md)\r
22 includes directions for building all the components, running the validation tests and running the demo applications.\r
23 \r
24 Information on how to enable the various Validation layers is in\r
25 [layers/README.md](layers/README.md).\r
26 \r
27 \r
28 ## License\r
29 This work is intended to be released as open source under a MIT-style\r
30 license once the Vulkan specification is public. Until that time, this work\r
31 is covered by the Khronos NDA governing the details of the VK API.\r
32 \r
33 ## Acknowledgements\r
34 While this project is being developed by LunarG, Inc; there are many other\r
35 companies and individuals making this possible: Valve Software, funding\r
36 project development; Intel Corporation, providing full hardware specifications\r
37 and valuable technical feedback; AMD, providing VK spec editor contributions;\r
38 ARM, contributing a Chairman for this working group within Khronos; Nvidia,\r
39 providing an initial co-editor for the spec; Qualcomm for picking up the\r
40 co-editor's chair; and Khronos, for providing hosting within GitHub.\r
41 \r