summaryrefslogtreecommitdiff
path: root/tests/files
diff options
context:
space:
mode:
Diffstat (limited to 'tests/files')
-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.