Add README section to run the tests#1144
Add README section to run the tests#1144SqAtx wants to merge 1 commit intogetting-things-gnome:masterfrom
Conversation
|
I think the chosen text puts a bit too much on the "why" rather than "how" to run it in a README file, which should be straight to the point. Also:
|
|
I agree with @Neui 's remarks.
Not so sure about this. I think it's better to keep builds-to-run and builds-to-test separate, to avoid any mixups |
Fair point. Figured I'd put it here to remind myself of the "why" but you're probably right - there may be a place for such documentation but that place isn't here.
The thinking behind it was that if they ever drift apart (i.e. we update the workflow but not the README), the README will still point to an example of a setup that works. That said, the workflow actually does a lot more than this simple setup, so it might not be that relevant.
Come to think of it, maybe that's what the GHA workflow should be running, even. I'm not too fussed about that right now, just trying to lower the barrier to entry. |
e67dde8 to
c85f5ac
Compare
| following one-time step: | ||
| ```sh | ||
| meson setup ./build | ||
| cd GTG/core/ && ln -s ../../.build/GTG/core/info.py . |
There was a problem hiding this comment.
This isn't pretty, but my first idea didn't work:
$ ln -s .build/GTG/core/info.py GTG/core/
$ ls -l GTG/core/info.py
lrwxrwxrwx 1 kevin kevin 23 Nov 8 21:10 GTG/core/info.py -> .build/GTG/core/info.py
|
Just tested this and I'm getting a |
|
Hi there! I have to decline the request to review this PR. My priorities have shifted away from GTG. |
Describe a simple way to get the tests running. This should help clear the confusion around the
ModuleNotFoundError: No module named 'GTG.core.info'type of errors you get when just runningpytest(see #1141).Adapted from the explanation at #1036
We can close #1141 and #1142