aboutsummaryrefslogtreecommitdiff
path: root/test/lua/README.md
diff options
context:
space:
mode:
authorRandy Palamar <randy@rnpnr.xyz>2024-05-21 19:53:22 -0600
committerRandy Palamar <randy@rnpnr.xyz>2024-05-21 19:53:22 -0600
commitb7074021b7bfb0932b889b9560dd22df31cef818 (patch)
tree0295b18de8fb8ea5289cbda95675687ae06025ff /test/lua/README.md
parentb7f8018a00be930e3f2b864949aec1f91291309c (diff)
parentefafa3c178268a4149fc3e432bc1174a013c16de (diff)
downloadvis-b7074021b7bfb0932b889b9560dd22df31cef818.tar.gz
vis-b7074021b7bfb0932b889b9560dd22df31cef818.tar.xz
Merge vis-tests into test directory
Going forward all tests should be submitted here directly.
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.