diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index a92cec1..7986e4d 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -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: @@ -17,3 +17,6 @@ godot --version ``` This track uses Godot version 4.7.2. + +[godot-engine]: https://godotengine.org/ +[download]: https://godotengine.org/download/ diff --git a/docs/TESTS.md b/docs/TESTS.md index 003bb93..afc8c5d 100644 --- a/docs/TESTS.md +++ b/docs/TESTS.md @@ -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 -- -``` +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