From c85f5acad702cbcab257479acd297b4c790a829d Mon Sep 17 00:00:00 2001
From: Kevin Guillaumond <kevin@guillaumond.me>
Date: Sat, 21 Sep 2024 14:50:45 -0700
Subject: [PATCH] Add README section to run the tests

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index d59cb462d..e9a850268 100644
--- a/README.md
+++ b/README.md
@@ -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 .
+```
+
+Then you can run the tests with `pytest` in the repository root.
+
+
 # "Where is my user data and config stored?"
 
 It depends: