build: Update known-good files for 1.2.146 header
[platform/upstream/Vulkan-Tools.git] / README.md
index 268d5dc..837d20f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,52 +1,46 @@
 # Vulkan Ecosystem Components
 
-This project provides the Khronos official ICD loader and validation layers for Vulkan developers on Windows and Linux.
+This project provides Khronos official Vulkan Tools and Utilities for Windows, Linux, Android, and MacOS.
 
 ## CI Build Status
 | Platform | Build Status |
 |:--------:|:------------:|
-| Linux/Android | [![Build Status](https://travis-ci.org/KhronosGroup/Vulkan-LoaderAndValidationLayers.svg?branch=master)](https://travis-ci.org/KhronosGroup/Vulkan-LoaderAndValidationLayers) |
-| Windows |[![Build status](https://ci.appveyor.com/api/projects/status/ri4584d6qramrjiv/branch/master?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/vulkan-loaderandvalidationlayers/branch/master) |
+| Linux/Android | [![Build Status](https://travis-ci.org/KhronosGroup/Vulkan-Tools.svg?branch=master)](https://travis-ci.org/KhronosGroup/Vulkan-Tools) |
+| Windows |[![Build status](https://ci.appveyor.com/api/projects/status/hwc1hy417hf42xnf?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/vulkan-tools/branch/master) |
 
 
 ## Introduction
 
-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 VkInstance-level Vulkan commands.  Additionally, the loader manages inserting
-Vulkan layer libraries such as validation layers between the application and the ICD.
+This project provides Vulkan tools and utilities that can assist development by enabling developers to
+verify their applications correct use of the Vulkan API.
 
 The following components are available in this repository:
-- [Vulkan header files](include/vulkan/)
-- [*ICD Loader*](loader/)
-- [*Validation Layers*](layers/)
 - [*Mock ICD*](icd/)
-- [*Demos*](demos/)
-- [*Tests*](tests/)
+- [*Vkcube and Vkcube++ Demo*](cube/)
+- [*VulkanInfo*](vulkaninfo/)
+- [*Windows Runtime*](windows-runtime-installer/)
 
 ## Contact Information
-[Tobine Ehlis](mailto:tobine@google.com)
-[Mark Lobodzinski](mailto:mark@lunarg.com)
+* [Tobin Ehlis](mailto:tobine@google.com)
+[Mark Lobodzinski](mailto:mark@lunarg.com)
 
 ## 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.
+Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
+Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for repository management details.
 
 ## How to Build and Run
 
 [BUILD.md](BUILD.md)
-Includes directions for building all components as well as running validation tests and demo applications.
+Includes directions for building all components as well as running the vkcube demo applications.
+
+## Version Tagging Scheme
+
+Updates to the `Vulkan-Tools` repository which correspond to a new Vulkan specification release are tagged using the following format: `v<`_`version`_`>` (e.g., `v1.1.96`).
 
-Information on how to enable the various Validation layers is in
-[layers/README.md](layers/README.md).
+**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`).
 
-Architecture and interface information for the loader is in
-[loader/LoaderAndLayerInterface.md](loader/LoaderAndLayerInterface.md).
+This scheme was adopted following the 1.1.96 Vulkan specification release.
 
 ## License
 This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.