aboutsummaryrefslogtreecommitdiff
path: root/README_TEST.md
diff options
context:
space:
mode:
Diffstat (limited to 'README_TEST.md')
-rw-r--r--README_TEST.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README_TEST.md b/README_TEST.md
new file mode 100644
index 00000000..774ad3cb
--- /dev/null
+++ b/README_TEST.md
@@ -0,0 +1,17 @@
+Running tests requires Catch2 and cmake
+
+# Running Tests
+```sh
+mkdir cbuild && cd cbuild
+cmake ..
+make test
+
+# usage: run all tests
+./test/test
+
+# usage: Optionally specify tests and success verbosity
+./test/test [bass] --success
+```
+
+# Writing Tests
+`[noci]` tag is used to disable a test on Github actions