summaryrefslogtreecommitdiff
path: root/test/vis/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/vis/README.md')
-rw-r--r--test/vis/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/test/vis/README.md b/test/vis/README.md
new file mode 100644
index 0000000..e7e655d
--- /dev/null
+++ b/test/vis/README.md
@@ -0,0 +1,17 @@
+Tests for vis specific editing features
+---------------------------------------
+
+The basic idea is to feed keyboard input to `vis` and compare the
+produced output with a known reference solution.
+
+A test constitutes of 3 files:
+
+ * `test.in` the file/buffer content with which the editor is started
+ * `test.keys` a file containing the keyboard input as would normally
+ be typed by a user
+ * `test.ref` a reference file at the end of the editing session
+
+The toplevel shell script `test.sh` looks for these files in sub
+directories, feeds the keys to `vis` and compares the produces output.
+
+Type `make` to run all tests.