aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Oliver <contact@pauloliver.dev>2026-06-25 04:42:23 +0200
committerPaul Oliver <contact@pauloliver.dev>2026-06-28 02:50:18 +0200
commit95fd6ae836ab5fee7387f4df46b727165a05b723 (patch)
tree79c715d250f44c1aa1a0d05e65be313ae4cd3e15 /README.md
parent0f5581f53f73a92d33826c4771553a9683376e67 (diff)
Adds v1 unit tests and fixes bugs found by them
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index fa9e811..5dadfea 100644
--- a/README.md
+++ b/README.md
@@ -97,3 +97,18 @@ user@host$ ./salis.py client -o -i ${SERVER_IP}
- ImGui
- ImPlot
- OpenGL
+
+## Unit tests
+A set of unit tests are included in this repo. Run them using the following command:
+```console
+user@host$ ./salis.py test
+```
+
+Optionally, you may run a single test (or a test subset) using the `-p` argument:
+```console
+user@host$ ./salis.py test -p 'test_v1.*'
+```
+
+Tests will fail in case any needed dependencies are missing, and thus help ensure
+the host system is properly configured. Ensure all tests pass before attempting to run
+new simulations.