aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc André Tanner <mat@brain-dump.org>2017-03-15 21:18:26 +0100
committerMarc André Tanner <mat@brain-dump.org>2017-03-15 21:18:26 +0100
commit668cef748146b8cbc7540c23d8339499390c9ff4 (patch)
tree78b74a5dc995c0ddddc0fd67da7e2f2378a5c519
parent62fff9853ec326a21a3891b4d5a212dd69ba86a4 (diff)
downloadvis-668cef748146b8cbc7540c23d8339499390c9ff4.tar.gz
vis-668cef748146b8cbc7540c23d8339499390c9ff4.tar.xz
test/lua: update README
-rw-r--r--lua/README.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/lua/README.md b/lua/README.md
index 4f8a6fb..5b9a1e6 100644
--- a/lua/README.md
+++ b/lua/README.md
@@ -1,13 +1,10 @@
-Tests for vis specific lua api
-------------------------------
+Unit Test for Vis' Lua API
+--------------------------
-Tests are formed from a `<test>.in`, `<test>.ref` and `<test>.out` triplet.
-The `<test>.in` file is opened by vis, some operatations are performed and the
-modified file is written to `<test>.out`. The new `<test>.out` is compared to
-`<test>.ref` and the test passes if they are identical.
+The tests use the [busted unit testing framework](https://olivinelabs.com/busted/).
-The shell script `test.sh` looks for a file with extension `.in`, eg `test.in`,
-and opens it in vis. The corresponding lua file, `test.lua`, is executed and is
-expected to create a `test.out` file.
+Each `*.lua` file is sourced from a new `vis` instance which loads the
+correspending `*.in` file.
-Type `make` to run all tests.
+Use the `test.sh` shell script to run an individual test or type `make`
+to run all tests.