aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
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.