Update README.md and change CI concurrency
- Add CI build status
- Use different concurrency id for the main branch - so we don't cancel builds for pushes to `main`
- Add matrix space badge
- Format logo to be centered and only 50% width
- Use notext logo since "Dawn" is already written below in the Markdown title. No text also displays better in dark mode UI.
Change-Id: If6fa457ae1d7bbdad3c53eb14db52dc2a2ecf9d3
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/160141
Kokoro: Kokoro <noreply+kokoro@google.com>
Commit-Queue: Austin Eng <enga@chromium.org>
Auto-Submit: Austin Eng <enga@chromium.org>
Reviewed-by: Kai Ninomiya <kainino@chromium.org>
Kokoro: Austin Eng <enga@chromium.org>
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index b58853a..f1d346f 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -6,7 +6,10 @@
pull_request:
concurrency:
- group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+ # Use github.run_id on main branch
+ # Use github.event.pull_request.number on pull requests, so it's unique per pull request
+ # Use github.ref on other branches, so it's unique per branch
+ group: ${{ github.workflow }}-${{ github.ref == 'refs/heads/main' && github.run_id || github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
diff --git a/README.md b/README.md
index b0c8614..62ee198 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,17 @@
-![Dawn's logo: a sun rising behind a stylized mountain inspired by the WebGPU logo. The text "Dawn" is written below it.](docs/imgs/dawn_logo.png "Dawn's logo")
+<div align="center">
+ <img
+ title="Dawn's logo"
+ alt="Dawn's logo: a sun rising behind a stylized mountain inspired by the WebGPU logo."
+ src="docs/imgs/dawn_logo_notext.png"
+ width="50%">
+
+ ![Build Status](https://github.com/google/dawn/actions/workflows/ci.yml/badge.svg?branch=main&event=push)
+ [![Matrix Space](https://img.shields.io/static/v1?label=Space&message=%23webgpu-dawn&color=blue&logo=matrix)](https://matrix.to/#/#webgpu-dawn:matrix.org)
+</div>
# Dawn, a WebGPU implementation
-Dawn is an open-source and cross-platform implementation of the work-in-progress [WebGPU](https://webgpu.dev) standard.
+Dawn is an open-source and cross-platform implementation of the [WebGPU](https://webgpu.dev) standard.
More precisely it implements [`webgpu.h`](https://github.com/webgpu-native/webgpu-headers/blob/main/webgpu.h) that is a one-to-one mapping with the WebGPU IDL.
Dawn is meant to be integrated as part of a larger system and is the underlying implementation of WebGPU in Chromium.
@@ -42,10 +51,6 @@
User documentation: (TODO, figure out what overlaps with the webgpu.h docs)
-## Status
-
-(TODO)
-
## License
BSD 3-Clause License, please see [LICENSE](/LICENSE).