Add track installation instructions #97
Conversation
| @@ -1,15 +1,15 @@ | |||
| # Installation | |||
|
|
|||
| <!-- TODO: write document | |||
| ## Installing Godot Engine | |||
There was a problem hiding this comment.
The idea here is that these should be instructions to setup the language for local testing. If it is meant that users should be using docker for testing then these docs should describe how to setup that for different os.
There was a problem hiding this comment.
I'm not sure it's about testing, per se — there's both docs/TESTS.md and exercises/shared/.docs/tests.md for that, hence my WIP branch for those.
The spec and example for this docs/INSTALLATION.md seem to point more to just installing Godot itself, no?
There was a problem hiding this comment.
It is supposed to tell you how to install so you can test the tests locally.
I mean in most cases, say Python. You would install Python and then you could install the library needed and then simply run pytest and you would get the output. And some languages doesn't need any dependencies at all and have everything built in. So for Godot, if you need like a bash script for it to work. Then these instructions should tell you how to install that script for example.
There was a problem hiding this comment.
OK, fair enough — but then what goes in TESTS.md for Godot? Should it just point back to INSTALLATION.md because there's nothing else to say like other tracks might (skipped tests, etc.)? Or duplicate its info (doesn't sound ideal, but then again, there's explicit mention of doing that for resources vs. help)?
There was a problem hiding this comment.
So the difference between installation and tests is that installation says what/how you install to tests. But tests say how you test. So for python would that be something like:
INSTALLATION.md:
- How to install python
- How to install libraries
TESTS.md:
How to test e.g:
Find the folder with the exercise then cd into that folder
cd path/exercise
Then you have to call pytest.
| sudo mv gdscript-test-runner/ /opt/exercism/gdscript/test-runner/ | ||
| ``` | ||
|
|
||
| ### Step 2: Downloading the single-exercise test runner script |
There was a problem hiding this comment.
This part you actually don't have to include at all, since the user is expected to follow the general exercism instructions
There was a problem hiding this comment.
I'm confused — these aren't part of the general exercism instructions... local native Linux students will need to follow this as part of the installation, and it's not covered elsewhere.
There was a problem hiding this comment.
Wait my bad, didn't read to carefully, yes this should be here. You are right
| Assuming you have the `exercism` tool set up and have downloaded at least one GDScript exercise, it should have created an `exercism/gdscript` folder to house the exercises. | ||
| Save [the test runner][test-local-gdscript-solution] in this folder and mark the file executable. | ||
|
|
||
| ## Running tests |
There was a problem hiding this comment.
And this part should be in TESTS.md
There was a problem hiding this comment.
Lines 32-33 are still installation-related, though. You need to do this just once, to be able to test any exercise after that.
We can duplicate it over in TESTS.md if you want, but, without the previous step it won't work. So, in TESTS.md I can link to step 1 and duplicate step 2, if you want (but I'm not clear why).
There was a problem hiding this comment.
Like, Step 1 is needed for students and track maintainers. Step 2 is an installation step that only students need.
There was a problem hiding this comment.
I only marked line 35, but it seemingly also shows the lines above. But yes, 32-33 should be here
| To build and test GDScript scripts for Exercism, Godot will be run in "headless" mode from the CLI. | ||
| These instructions currently require Linux and bash. | ||
|
|
||
| ### Step 1: Installing the overall test runner infrastructure |
There was a problem hiding this comment.
But yes, this part should be here
No description provided.