github: Use main instead of master

[platform/upstream/Vulkan-Tools.git] / README.md

diff --git a/README.md b/README.md
index e23d009..ed26aa1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,9 +2,19 @@
 
 This project provides Khronos official Vulkan Tools and Utilities for Windows, Linux, Android, and MacOS.
 
-## CI Build Status
-[![Build Status](https://github.com/KhronosGroup/Vulkan-Tools/workflows/CI%20Build/badge.svg?branch=master)](https://github.com/KhronosGroup/Vulkan-Tools/actions)
+## 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
+[![Build Status](https://github.com/KhronosGroup/Vulkan-Tools/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/KhronosGroup/Vulkan-Tools/actions)
 
 ## Introduction