Skip to content
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

Add README section to run the tests #1144

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add README section to run the tests #1144

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,6 +182,20 @@ them locally with `pre-commit run --all-files`.
For more guidelines about contributing, see
[CONTRIBUTING.md](./CONTRIBUTING.md).

### Running the tests

Tests are run using `pytest`.

We first need some files to be pre-processed by meson, which is done by the
following one-time step:
```sh
meson setup ./build
cd GTG/core/ && ln -s ../../.build/GTG/core/info.py .
Copy link
Contributor Author

@SqAtx SqAtx Nov 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

```

Then you can run the tests with `pytest` in the repository root.


# "Where is my user data and config stored?"

It depends:
Expand Down