summaryrefslogtreecommitdiffstats
path: root/docs/tests.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/tests.md')
-rw-r--r--docs/tests.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/tests.md b/docs/tests.md
new file mode 100644
index 0000000..6007470
--- /dev/null
+++ b/docs/tests.md
@@ -0,0 +1,17 @@
+# Test suite
+pysilfont has a pytest-based test suite.
+
+### install the test framework bits:
+```
+python3 -m pip install pytest
+```
+
+## set up the folders:
+```
+python3 tests/setuptestdata.py
+```
+
+## run the test suite:
+```
+pytest
+```