aboutsummaryrefslogtreecommitdiff
path: root/test/lua/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/lua/README.md')
-rw-r--r--test/lua/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/test/lua/README.md b/test/lua/README.md
new file mode 100644
index 0000000..5b9a1e6
--- /dev/null
+++ b/test/lua/README.md
@@ -0,0 +1,10 @@
+Unit Test for Vis' Lua API
+--------------------------
+
+The tests use the [busted unit testing framework](https://olivinelabs.com/busted/).
+
+Each `*.lua` file is sourced from a new `vis` instance which loads the
+correspending `*.in` file.
+
+Use the `test.sh` shell script to run an individual test or type `make`
+to run all tests.