summaryrefslogtreecommitdiffstats
path: root/tests/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--tests/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/tests/README b/tests/README
new file mode 100644
index 0000000..5826773
--- /dev/null
+++ b/tests/README
@@ -0,0 +1,14 @@
+file tests
+==========
+
+This directory contains tests for file. It is highly encouraged to add
+one each time a bug is found, and each time new magic is added. Each
+test consists of two files:
+
+ TEST.testfile
+ TEST.result
+
+where TEST is the base name of the test, TEST.testfile is the input,
+and TEST.result is the desired output from file.
+
+To add a new test just add the test files to the directory.