From 95fd6ae836ab5fee7387f4df46b727165a05b723 Mon Sep 17 00:00:00 2001
From: Paul Oliver <contact@pauloliver.dev>
Date: Thu, 25 Jun 2026 04:42:23 +0200
Subject: Adds v1 unit tests and fixes bugs found by them

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

(limited to 'README.md')

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.
-- 
cgit v1.2.1