diff extras/testplan/README.txt @ 614:de1e3a47ed21

testplan: README.txt improved and converted to Creole.
author Bernhard Reiter <bernhard@intevation.de>
date Wed, 18 Jun 2014 16:35:03 +0200
parents 3d45f5bca0aa
children
line wrap: on
line diff
--- a/extras/testplan/README.txt	Wed Jun 18 15:10:00 2014 +0200
+++ b/extras/testplan/README.txt	Wed Jun 18 16:35:03 2014 +0200
@@ -1,39 +1,36 @@
-Test plan for TrustBridge
-=========================
+= Test plan for TrustBridge
 
-TrustBridge uses the free test plan framework "intest" [1] to fill
-out test plans with a simple web server and produce test plan
-protocols as PDF document.
+TrustBridge uses the Free Software test plan framework 
+  [[https://wald.intevation.org/projects/intests/]]
+to fill out test plans with a simple web server.
+InTEsts can also produce PDF output.
 
-Initially, fetch current intests hg-repository:
+To start, fetch the current version of inTests:
 
-   $ hg clone https://hg.intevation.org/intests
+{{{
+  hg clone https://hg.intevation.org/intests
+}}}
 
 
-Run test plan
--------------
+== Completing a test plan
 
-1. Create a working copy of original testplan.xml into
-   the intests directory:
-   $ cd intests
-   $ cp /path/to/testplan.xml testplan.xml
-
-2. Start web server [optional with port number]:
-   $ python main.py testplan.xml [PORT]
-
-3. Enter test information
+# Create a working copy of original testplan.xml into the intests directory:
+ {{{
+  cd intests
+  cp /path/to/testplan.xml testplan.xml
+ }}}
+# Start web server [optional with port number]:
+ {{{
+  python main.py testplan.xml [PORT]
+ }}}
+# Enter test information
    (date, OS, tester, version, comment)
-
-4. Run all tests of each test suite and
+# Run all tests of each test suite and
    record the test results (yes = passed, no = failed, n/a).
-
-5. Quit web server
-
-6. Create test plan protocol as PDF:
-   $ xsltproc --stringparam lang de xforms/xml2tex.xsl testplan.xml > tex/testplan.tex
-   $ cd tex
-   $ make testplan.pdf
-
-
----
-[1] https://wald.intevation.org/projects/intests/
+# Quit web server
+# Create test plan protocol as PDF:
+{{{
+  xsltproc --stringparam lang de xforms/xml2tex.xsl testplan.xml > tex/testplan.tex
+  cd tex
+  make testplan.pdf
+}}}

http://wald.intevation.org/projects/trustbridge/