aboutsummaryrefslogtreecommitdiff
path: root/tests/README.md
diff options
context:
space:
mode:
authorJuan J. Martínez <jjm@usebox.net>2021-10-02 12:33:04 +0000
committerJuan J. Martínez <jjm@usebox.net>2021-10-02 12:33:04 +0000
commitcaa22e5bbd158fd8d563588293aa763ca5801bed (patch)
tree0789e731afeb7844fd68976fc0b1ea53ec4517d7 /tests/README.md
parentc14900274f20d119c6704f910eec420bf2998866 (diff)
downloadubox-msx-lib-caa22e5bbd158fd8d563588293aa763ca5801bed.tar.gz
ubox-msx-lib-caa22e5bbd158fd8d563588293aa763ca5801bed.zip
Start the test suite
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 0000000..c0139a8
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,14 @@
+# ubox MSX lib test suite
+
+The tests are written in python 3 and follow this convention:
+
+| Test class | Filename |
+| --- | --- |
+| TestMyCase | test_my_case.py |
+
+See `test_rom.py` as an example.
+
+Remember to make the test file executable!
+
+**TODO**: add a module to support openMSX remote control.
+