Skip to content

Update the install docs (add links) and test docs (use the per-exercise runner) #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IsaacG merged 1 commit into from
Oct 1, 2026
Merged

Update the install docs (add links) and test docs (use the per-exercise runner) #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The Godot Engine runs on Windows, Linux, macOS, and Android.

## Installing Godot Engine

The Godot Engine can be downloaded directly from [the Godot Engine website][godot-engine].
The Godot Engine can be downloaded directly from [the Godot Engine website][download].
The download contains a single executable, named with the Godot Engine version.
This file needs to renamed `godot` and placed in one of the `$PATH` directories.
After completing the installation, you can verify if the CLI was installed successfully by running this command in a terminal:
Expand All @@ -17,3 +17,6 @@ godot --version
```

This track uses Godot version 4.7.2.

[godot-engine]: https://godotengine.org/
[download]: https://godotengine.org/download/
27 changes: 4 additions & 23 deletions docs/TESTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,16 @@ You'll need [Godot installed][installation] correctly to use the test runner.
## Running tests

The [test runner][] is used to load and test solutions.
To run the test runner, download it locally then use `godot` to run the test runner.
In the future, the test runner will automatically be downloaded alongside exercises when using `exercism download`.
When an exercise is downloaded locally, a copy of the test runner is included, along with a shell script to invoke it.

### Fetching the test runner

The following shell snippet can be used to download the test runner.

```bash
exercism download --track gdscript --exercise hello-world
cd "$(exercism workspace)/gdscript"
curl --remote-name https://raw.githubusercontent.com/exercism/gdscript-test-runner/refs/heads/main/bin/test_runner.gd
```

### Running the test runner

The test runner is run using `godot` in headless mode (no IDE).
`-s` or `--script` tells Godot to run the test runner script.
The test runner expects two arguments: the slug and the path to the solution directory.

```bash
godot --headless -s to/test_runner.gd -- <solution-slug> <path/to/solution>
```
To run the exercise, simply run the `./run_tests` script in the exercise directory.

For example,

```bash
godot --headless -s "$(exercism workspace)/gdscript/test_runner.gd" -- hello-world "$(exercism workspace)/gdscript/hello-world
cd "$(exercism workspace)/gdscript/hello-world"
./run_tests
```


[installation]: https://exercism.org/docs/tracks/gdscript/installation
[test runner]: https://raw.githubusercontent.com/exercism/gdscript-test-runner/refs/heads/main/bin/test_runner.gd
Loading