From a5592a5899ea2ee7065c629659df848732ccf5e9 Mon Sep 17 00:00:00 2001 From: Joanna May Date: Tue, 14 Mar 2023 19:00:11 -0500 Subject: [PATCH] docs: update readme --- .github/workflows/test.yml | 2 +- README.md | 21 ++++++++++++++------- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 768b526..c293318 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -8,7 +8,7 @@ on: # rebuild any PRs and main branch changes jobs: tests: - name: ๐Ÿงช Test on ${{ matrix.os }} + name: ๐Ÿงช Test on ${{ matrix.os }}, .NET=${{ matrix.use-dotnet }} runs-on: ${{ matrix.os }} strategy: # Don't cancel other OS runners if one fails. diff --git a/README.md b/README.md index 0e7faf6..e13ac8a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,12 @@ -# Setup Godot +# ๐Ÿค– Setup Godot -[![Chickensoft Badge][chickensoft-badge]][chickensoft-website] [![Discord][discord-badge]][discord] +[![Chickensoft Badge][chickensoft-badge]][chickensoft-website] [![Discord][discord-badge]][discord] [![Read the docs][read-the-docs-badge]][docs] -Setup Godot for use with .NET on macOS, Windows, and Linux CI/CD runners. +Setup Godot for use with (or without) .NET on macOS, Windows, and Linux CI/CD runners. - โœ… Godot 4.x - โœ… C# supported using .NET version of Godot. +- โœ… Versions **without** .NET are also supported. - โœ… Installs Godot directly on the CI/CD runner. - โœ… Caches Godot installation for speedier workflows. - โœ… Adds environment variables (`GODOT4`, `GODOT`) to the system path. @@ -59,6 +60,8 @@ jobs: # Version must include major, minor, and patch, and be >= 4.0.0 # Pre-release label is optional. version: 4.0.0-beta16 # also valid: 4.0.0.rc1 or 4.0.0, etc + # Use .NET-enabled version of Godot (the default is also true). + use-dotnet: true - name: ๐Ÿ”ฌ Verify Setup run: | @@ -74,10 +77,14 @@ jobs: # Do whatever you want! ``` - +## Inputs - -[chickensoft-badge]: https://chickensoft.games/images/chickensoft/chickensoft_badge.svg +See [action.yml][action] for information about the action's inputs. + +[chickensoft-badge]: https://raw.githubusercontent.com/chickensoft-games/chickensoft_site/main/static/img/badges/chickensoft_badge.svg [chickensoft-website]: https://chickensoft.games +[discord-badge]: https://raw.githubusercontent.com/chickensoft-games/chickensoft_site/main/static/img/badges/discord_badge.svg [discord]: https://discord.gg/gSjaPgMmYW -[discord-badge]: https://img.shields.io/badge/Chickensoft%20Discord-%237289DA.svg?style=flat&logo=discord&logoColor=white +[read-the-docs-badge]: https://raw.githubusercontent.com/chickensoft-games/chickensoft_site/main/static/img/badges/read_the_docs_badge.svg +[docs]: https://chickensoft.games/docs +[action]: ./action.yml