document test running

DavidBuchanan314 · Jan 9, 2025 · ae955db · ae955db
1 parent a4557c2
commit ae955db
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,3 +29,11 @@ podman run --rm -it -p 8123:8123 millipds_dev
 ### Production deployment on Ubuntu (and similar systems) [WIP]
 
 See [./docs/DEPLOY.md](./docs/DEPLOY.md)
+
+
+### Running the tests locally
+
+```sh
+python3 -m pip install -e .[test]  # install the testing dependencies (only needed once, unless new deps are added)
+python3 -m pytest .  # run the tests
+```