aboutsummaryrefslogtreecommitdiffstats
path: root/tests/files/README
diff options
context:
space:
mode:
authorMartin Vilcans <martin@librador.com>2012-07-10 00:09:00 +0200
committerMartin Vilcans <martin@librador.com>2012-07-10 00:28:14 +0200
commit6b8ecde671306398f1c242df74ef918e12724f35 (patch)
tree9e7b0cba6e4cb4d30e8a50c4f38a21cca83f91df /tests/files/README
parent64d171de1345bc389a406cce8d980967b4202b98 (diff)
downloadscreenplain-6b8ecde671306398f1c242df74ef918e12724f35.tar.gz
Automatically create test cases from files in tests/files
This replaces the repeated test code.
Diffstat (limited to 'tests/files/README')
-rw-r--r--tests/files/README18
1 files changed, 18 insertions, 0 deletions
diff --git a/tests/files/README b/tests/files/README
new file mode 100644
index 0000000..b63ce04
--- /dev/null
+++ b/tests/files/README
@@ -0,0 +1,18 @@
+This directory contains test cases.
+
+There are two kinds of files in this directory:
+
+A "source file" has just one extension, e.g. 'foo.fountain'.
+An "expect file" has two extensions, e.g. 'foo.fountain.html'.
+
+For each source file, Screenplain is run to see if it produces
+the content of the corresponding expect file(s).
+
+E.g. for the following files:
+
+foo.fountain, foo.fountain.html, foo.fountain.fdx
+
+Screenplain will be run with foo.fountain as input and HTML output.
+The result is compared to foo.fountain.html.
+Then the same thing is done with FDX output, which is compared
+to foo.fountain.fdx.