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 ## Default branch changed to 'main' 2023-01-16
   6
   7 As discussed in #729, the default branch of this repository is now 'main'. This change should be largely transparent to repository users, since github rewrites many references to the old 'master' branch to 'main'. However, if you have a checked-out local clone, you may wish to take the following steps as recommended by github:
   8
   9 ```sh
  10 git branch -m master main
  11 git fetch origin
  12 git branch -u origin/main main
  13 git remote set-head origin -a
  14 ```
  15
  16 ## CI Build Status
  17 [![Build Status](https://github.com/KhronosGroup/Vulkan-Tools/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/KhronosGroup/Vulkan-Tools/actions)
  18
  19 ## Introduction
  20
  21 This project provides Vulkan tools and utilities that can assist development by enabling developers to
  22 verify their applications correct use of the Vulkan API.
  23
  24 The following components are available in this repository:
  25 - [*Mock ICD*](icd/)
  26 - [*Vkcube and Vkcube++ Demo*](cube/)
  27 - [*VulkanInfo*](vulkaninfo/)
  28 - [*Windows Runtime*](windows-runtime-installer/)
  29
  30 ## Contact Information
  31 * [Tobin Ehlis](mailto:tobine@google.com)
  32 * [Mark Lobodzinski](mailto:mark@lunarg.com)
  33
  34 ## Information for Developing or Contributing:
  35
  36 Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
  37 Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for repository management details.
  38
  39 ## How to Build and Run
  40
  41 [BUILD.md](BUILD.md)
  42 Includes directions for building all components as well as running the vkcube demo applications.
  43
  44 ## Version Tagging Scheme
  45
  46 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`).
  47
  48 **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`).
  49
  50 This scheme was adopted following the 1.1.96 Vulkan specification release.
  51
  52 ## License
  53 This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.
  54
  55 See LICENSE.txt for a full list of licenses used in this repository.
  56
  57 ## Acknowledgements
  58 While this project has been developed primarily by LunarG, Inc., there are many other
  59 companies and individuals making this possible: Valve Corporation, funding
  60 project development; Google providing significant contributions to the validation layers;
  61 Khronos providing oversight and hosting of the project.