summaryrefslogtreecommitdiff
path: root/test/README.test
diff options
context:
space:
mode:
Diffstat (limited to 'test/README.test')
-rwxr-xr-xtest/README.test9
1 files changed, 9 insertions, 0 deletions
diff --git a/test/README.test b/test/README.test
new file mode 100755
index 0000000..11ac3b8
--- /dev/null
+++ b/test/README.test
@@ -0,0 +1,9 @@
+The code in this directory produces a test for Xdelta. To run it you
+have to edit the hard-coded constants at the top of the file, which
+include "cmd_data_source", which should be the name of a big file
+containing source data that the test uses to construct sample inputs.
+This allows you to test on whatever kind of data you want, but the
+synthetic edits are still hardcoded. Have a look.
+
+Of course, a better test would let you run it without any
+configuration, but this is not that test.