diff options
| author | juan-lunarg <juan@lunarg.com> | 2023-05-04 13:28:19 -0600 |
|---|---|---|
| committer | Juan Ramos <114601453+juan-lunarg@users.noreply.github.com> | 2023-05-04 15:29:27 -0600 |
| commit | ebf2caea656df8b0959487045dcdbb32ed5ba609 (patch) | |
| tree | d860d11f197b4773681ed2799965bceb38f3bd07 /README.md | |
| parent | b647be6419696dac2f5e009d7e27913d987f037b (diff) | |
| download | Vulkan-Tools-ebf2caea656df8b0959487045dcdbb32ed5ba609.tar.gz Vulkan-Tools-ebf2caea656df8b0959487045dcdbb32ed5ba609.tar.bz2 Vulkan-Tools-ebf2caea656df8b0959487045dcdbb32ed5ba609.zip | |
docs: Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 30 |
1 files changed, 6 insertions, 24 deletions
@@ -1,35 +1,18 @@ -# Vulkan Ecosystem Components +# KhronosGroup/Vulkan-Tools -This project provides Khronos official Vulkan Tools and Utilities for Windows, Linux, Android, and MacOS. +This project provides Vulkan tools and utilities that can assist development by enabling developers to verify their applications correct use of the Vulkan API. -## Default branch changed to 'main' 2023-01-16 - -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: - -```sh -git branch -m master main -git fetch origin -git branch -u origin/main main -git remote set-head origin -a -``` - -## CI Build Status -[](https://github.com/KhronosGroup/Vulkan-Tools/actions) - -## 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. +## Intro 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) +* [Charles Giessen](mailto:charles@lunarg.com) ## Information for Developing or Contributing: @@ -38,8 +21,7 @@ Please see the [GOVERNANCE.md](GOVERNANCE.md) file in this repository for reposi ## How to Build and Run -[BUILD.md](BUILD.md) -Includes directions for building all components as well as running the vkcube demo applications. +[BUILD.md](BUILD.md) includes directions for building all components as well as running the vkcube demo applications. ## Version Tagging Scheme |