README.md

   1 # Vulkan Ecosystem Components
   2
   3 This project provides Khronos official Vulkan Tools and Utilities for Windows, Linux, Android, and MacOS.
   4
   5 ## CI Build Status
   6 | Platform | Build Status |
   7 |:--------:|:------------:|
   8 | Linux/Android | [![Build Status](https://travis-ci.org/KhronosGroup/Vulkan-Tools.svg?branch=master)](https://travis-ci.org/KhronosGroup/Vulkan-Tools) |
   9 | Windows |[![Build status](https://ci.appveyor.com/api/projects/status/hwc1hy417hf42xnf?svg=true)](https://ci.appveyor.com/project/Khronoswebmaster/vulkan-tools/branch/master) |
  10
  11
  12 ## Introduction
  13
  14 This project provides Vulkan tools and utilities that can assist development by enabling developers to
  15 verify their applications correct use of the Vulkan API.
  16
  17 The following components are available in this repository:
  18 - [*Mock ICD*](icd/)
  19 - [*Vkcube and Vkcube++ Demo*](cube/)
  20 - [*VulkanInfo*](vulkaninfo/)
  21 - [*Windows Runtime*](windows-runtime-installer/)
  22
  23 ## Contact Information
  24 * [Tobin Ehlis](mailto:tobine@google.com)
  25 * [Mark Lobodzinski](mailto:mark@lunarg.com)
  26
  27 ## Information for Developing or Contributing:
  28
  29 Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
  30 Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for repository management details.
  31
  32 ## How to Build and Run
  33
  34 [BUILD.md](BUILD.md)
  35 Includes directions for building all components as well as running the vkcube demo applications.
  36
  37 ## Version Tagging Scheme
  38
  39 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`).
  40
  41 **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`).
  42
  43 This scheme was adopted following the 1.1.96 Vulkan specification release.
  44
  45 ## License
  46 This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.
  47
  48 See COPYRIGHT.txt for a full list of licenses used in this repository.
  49
  50 ## Acknowledgements
  51 While this project has been developed primarily by LunarG, Inc., there are many other
  52 companies and individuals making this possible: Valve Corporation, funding
  53 project development; Google providing significant contributions to the validation layers;
  54 Khronos providing oversight and hosting of the project.