build: Update known-good files for 1.2.146 header
[platform/upstream/Vulkan-Tools.git] / README.md
old mode 100755 (executable)
new mode 100644 (file)
index eef7e35..837d20f
--- a/README.md
+++ b/README.md
@@ -1,41 +1,54 @@
-# Vulkan Ecosystem Components\r
-*Version 1.0, January 25, 2016*\r
-\r
-This project provides loader and validation layers for Vulkan developers on Windows and Linux.\r
-\r
-## Introduction\r
-\r
-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
-\r
-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
-\r
-The following components are available in this repository:\r
-- Vulkan header files\r
-- [*ICD Loader*](loader) and [*Layer Manager*](layers/README.md, loader/README.md\r
-- Core [*Validation Layers*](layers/)\r
-- Demos and tests for the loader and validation layers\r
-\r
-\r
-## How to Build and Run\r
-\r
-[BUILD.md](BUILD.md)\r
-includes directions for building all the components, running the validation tests and running the demo applications.\r
-\r
-Information on how to enable the various Validation layers is in\r
-[layers/README.md](layers/README.md).\r
-\r
-\r
-## License\r
-This work is intended to be released as open source under a MIT-style\r
-license once the Vulkan specification is public. Until that time, this work\r
-is covered by the Khronos NDA governing the details of the VK API.\r
-\r
-## Acknowledgements\r
-While this project is being developed by LunarG, Inc; there are many other\r
-companies and individuals making this possible: Valve Software, funding\r
-project development; Intel Corporation, providing full hardware specifications\r
-and valuable technical feedback; AMD, providing VK spec editor contributions;\r
-ARM, contributing a Chairman for this working group within Khronos; Nvidia,\r
-providing an initial co-editor for the spec; Qualcomm for picking up the\r
-co-editor's chair; and Khronos, for providing hosting within GitHub.\r
-\r
+# Vulkan Ecosystem Components
+
+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-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
+
+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:
+- [*Mock ICD*](icd/)
+- [*Vkcube and Vkcube++ Demo*](cube/)
+- [*VulkanInfo*](vulkaninfo/)
+- [*Windows Runtime*](windows-runtime-installer/)
+
+## Contact Information
+* [Tobin Ehlis](mailto:tobine@google.com)
+* [Mark Lobodzinski](mailto:mark@lunarg.com)
+
+## Information for Developing or Contributing:
+
+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 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`).
+
+**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`).
+
+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.
+
+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
+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.