build: Update known-good files for 1.2.146 header
[platform/upstream/Vulkan-Tools.git] / README.md
index 0681493..837d20f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,58 +1,54 @@
-# Explicit GL (XGL) Ecosystem Components\r
-*Version 0.2, Spinning Cube, 31 Oct 2014*\r
-\r
-This project provides *open source* components for the XGL Ecosystem.\r
-\r
-## Introduction\r
-\r
-The components here are being shared with the Khronos community to provide\r
-early insights into the specification of XGL and to assists those doing\r
-prototyping at this point.\r
-\r
-The following components are available:\r
-- Proposed Reference [*ICD Loader*](https://github.com/KhronosGroup/GL-Next/tree/master/loader) (including [*Layer Management*](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md))\r
-- Proposed Reference [*Validation Layers*](https://github.com/KhronosGroup/GL-Next/tree/master/layers/)\r
-  - [Object Tracker](https://github.com/KhronosGroup/GL-Next/blob/master/layers/object_track.c)\r
-  - [Draw State](https://github.com/KhronosGroup/GL-Next/blob/master/layers/draw_state.c)\r
-- *GLAVE Debugger* ([API Dump](https://github.com/KhronosGroup/GL-Next/blob/master/layers/api_dump.c) only)\r
-- [*Sample Driver*](https://github.com/KhronosGroup/GL-Next/tree/master/icd)\r
-  - [Common Infrastructure](https://github.com/KhronosGroup/GL-Next/tree/master/icd/common)\r
-  - [Implementation for Intel GPUs](https://github.com/KhronosGroup/GL-Next/tree/master/icd/intel)\r
-\r
-## How to Build and Run\r
-\r
-This release demonstrates a spinning textured cube as an example of the\r
-vertical slice of XGL functionality running on Ubuntu 14.10 with an Intel\r
-GPU. Included are instructions for\r
-[building all the components](https://github.com/KhronosGroup/GL-Next/tree/master/BUILD.md)\r
-and\r
-[running the XGL spinning cube demo application](https://github.com/KhronosGroup/GL-Next/tree/master/demos/README.md).\r
-\r
-Information on how to enable the API Dump and Validation layers is in\r
-[layers/README.md](https://github.com/KhronosGroup/GL-Next/tree/master/layers/README.md).\r
-\r
-## References\r
-This version of the components are written based on the following preliminary specs and proposals:\r
-- [**XGL Programers Reference**, 1 Jul 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/AMD/Explicit%20GL%20Programming%20Guide%20and%20API%20Reference.pdf)\r
-- [**BIL**, version 1.0, revision 18](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/BIL/Specification/BIL.html)\r
-- [**IMG's Fixed Function Proposal**, 28 Oct 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/IMG/xgl_vertex_input_description2_img.h)\r
-- [**Valve's Loader Proposal**, 7 Oct 2014](https://cvs.khronos.org/svn/repos/oglc/trunk/nextgen/proposals/Valve/xglLayers.pptx)\r
-\r
-## License\r
-This work is intended to be released as open source under a BSD-style\r
-license once the XGL specification is public. Until that time, this work\r
-is covered by the Khronos NDA governing the details of the XGL 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 XGL 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
-## Contact\r
-If you have questions or comments about this driver; or you would like to contribute\r
-directly to this effort, please contact us at XGL@LunarG.com; or if you prefer, via\r
-the GL Common mailing list: gl_common@khronos.org\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.