From 18952112338f1070cb87d9b8af6559d4eb565390 Mon Sep 17 00:00:00 2001 From: Minimata Date: Wed, 28 Jan 2026 16:18:08 +0100 Subject: [PATCH] update README --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9096e94..f2181ba 100644 --- a/README.md +++ b/README.md @@ -17,15 +17,33 @@ This GitHub Action automates the setting up of Godot Mono. The action can be configured using various inputs to suit your testing needs. Here's a basic usage pattern: ```yaml -- uses: https://git.game-dev.space/minimata/setup-godot.git@main +- name: Setup Godot + id: setup-godot + uses: https://git.game-dev.space/minimata/setup-godot.git@main with: - godot-version: '4.6' # Required: Godot version to use - dotnet-version: 'net9.0' # Optional: Dotnet framework version + godot-version: '4.6' # Required: Godot version to use + dotnet-version: 'net9.0' # Optional: Dotnet framework version +``` + +### Ouputs + +The action outputs the location of the Godot bin under the name `godot_bin` + + +```yaml +- name: Setup Godot + id: setup-godot + uses: https://git.game-dev.space/minimata/setup-godot.git@main + with: + godot-version: '4.5.1' + +- name: Import resources and build solution + run: | + ${{ steps.setup-godot.outputs.godot_bin }} --headless --editor --build-solutions --quit --import --path $PWD ``` ## Configuration - ### Godot Configuration | Parameter | Required | Default | Description |