summaryrefslogtreecommitdiffstats
path: root/old/convert/README
diff options
context:
space:
mode:
Diffstat (limited to 'old/convert/README')
-rw-r--r--old/convert/README17
1 files changed, 17 insertions, 0 deletions
diff --git a/old/convert/README b/old/convert/README
new file mode 100644
index 0000000..4d3c7c4
--- /dev/null
+++ b/old/convert/README
@@ -0,0 +1,17 @@
+convert.pl converts a BAT Test Plan document (in LaTeX) to a QtUiTest test case
+(in QtScript). Formatting is retained as far as possible (using TWiki markup).
+
+Input is read from STDIN and output to STDOUT.
+
+Usage: perl convert.pl < document.tex > testcase.js
+
+NOTES
+1: Several assumptions are made about the structure of the document (eg,
+subsubsections correspond to test functions).
+2: Not all content in the document is converted, and not all layout is
+preserved. Converted tests must be reviewed against the original document.
+3: Tests are numbered in order, so adding a new test to the LaTeX document will
+result in subsequent tests having different numbers from what they had in
+previous revisions of the test plan. In order to be able to compare test results
+in a meaningful way, new tests must be added to the end of the document, not in
+the middle.