repo: Fix git submodules and AppVayor badge
[platform/upstream/Vulkan-Tools.git] / 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 - [*Cube and Cube++ Demo*](cube/)
20 - [*VulkanInfo*](vulkaninfo/)
21
22 ## Contact Information
23 * [Tobin Ehlis](mailto:tobine@google.com)
24 * [Mark Lobodzinski](mailto:mark@lunarg.com)
25
26 ## Information for Developing or Contributing:
27
28 Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file in this repository for more details.
29 Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for repository management details.
30
31 ## How to Build and Run
32
33 [BUILD.md](BUILD.md)
34 Includes directions for building all components as well as running the cube demo applications.
35
36 ## License
37 This work is released as open source under a Apache-style license from Khronos including a Khronos copyright.
38
39 See COPYRIGHT.txt for a full list of licenses used in this repository.
40
41 ## Acknowledgements
42 While this project has been developed primarily by LunarG, Inc., there are many other
43 companies and individuals making this possible: Valve Corporation, funding
44 project development; Google providing significant contributions to the validation layers;
45 Khronos providing oversight and hosting of the project.