From: juan-lunarg Date: Thu, 4 May 2023 19:12:47 +0000 (-0600) Subject: docs: Update README.md X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f372068d09fc13bcf54b8c81274f37aa5f46aea3;p=platform%2Fupstream%2FVulkan-Loader.git docs: Update README.md --- diff --git a/README.md b/README.md index 43a732c3..e0436444 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,6 @@ -# Vulkan Ecosystem Components +# Vulkan Loader -This project provides the Khronos official Vulkan ICD desktop loader for Windows, Linux, and MacOS. - -## Default branch changed to 'main' (January 23, 2023) - -As discussed in https://github.com/KhronosGroup/Vulkan-Loader/issues/1107, 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 - -[![Build Status](https://github.com/KhronosGroup/Vulkan-Loader/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/KhronosGroup/Vulkan-Loader/actions) +This project provides the Khronos official Vulkan Loader for all platforms except [Android](https://android.googlesource.com/platform/frameworks/native/+/master/vulkan/) ## Introduction @@ -42,16 +27,13 @@ The following components are available in this repository: ## 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. +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. +[BUILD.md](BUILD.md) includes directions for building all components. -Architecture and interface information for the loader is in -[docs/LoaderInterfaceArchitecture.md](docs/LoaderInterfaceArchitecture.md). +Architecture and interface information for the loader is in [docs/LoaderInterfaceArchitecture.md](docs/LoaderInterfaceArchitecture.md). ## Version Tagging Scheme @@ -63,8 +45,7 @@ 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. +This work is released as open source under a Apache-style license from Khronos including a Khronos copyright. ## Acknowledgements