Skip to content

Commit

Permalink
Add the GitHub actions badge to readmes (#58)
Browse files Browse the repository at this point in the history
* Try to add a GHA badge

* Another try

* Formatting

* Added the badge and a link to the tests to README.md
  • Loading branch information
ppenenko authored Jun 16, 2024
1 parent b88aed6 commit 77550a0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ Metashade is an experimental GPU shading domain-specific language (DSL) embedded
When a Metashade script executes, it generates code in a target shading language.
Only HLSL is supported so far but the intent is definitely to support multiple targets.

To see Metashade in action, check out the [glTF demo](gltfdemo).
To see Metashade in action, check out the [glTF demo](gltfdemo) or the [tests](tests) which are run by CI:
[![GitHub Actions CI](https://github.com/ppenenko/metashade/actions/workflows/python-package.yml/badge.svg)](https://github.com/ppenenko/metashade/actions/workflows/python-package.yml)

Please see the [presentation on Google Slides](https://docs.google.com/presentation/d/e/2PACX-1vQtYIwXIkMnVC6TzWTKPAtZIA6_xeUCQc8Mvyziu0qy7HDUduz_onsJ5TabxTuuVQ/pub?start=false&loop=false&delayms=3000) for a detailed discussion of the motivation for Metashade and its design.
For a detailed discussion of the motivation for Metashade and its design, please see the [presentation on Google Slides](https://docs.google.com/presentation/d/e/2PACX-1vQtYIwXIkMnVC6TzWTKPAtZIA6_xeUCQc8Mvyziu0qy7HDUduz_onsJ5TabxTuuVQ/pub?start=false&loop=false&delayms=3000).

## Rationale

Expand Down
3 changes: 2 additions & 1 deletion tests/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Our test cases follow the [pytest](https://pytest.org/) conventions.
Visual Studio Code sets up a pytest integration automagically.
The tests also run as part of [GitHub Actions CI](https://github.com/ppenenko/metashade/actions).
The tests also run as part of [GitHub Actions CI](https://github.com/ppenenko/metashade/actions):
[![GitHub Actions CI](https://github.com/ppenenko/metashade/actions/workflows/python-package.yml/badge.svg)](https://github.com/ppenenko/metashade/actions/workflows/python-package.yml)

Only the HLSL Shader Model 6.0 generator is tested currently. The automated tests don't involve any actual rendering yet, but rendering can be tested manually in the [glTF demo](../gltfdemo).

Expand Down

0 comments on commit 77550a0

Please sign in to comment.