sysops -> Sysops

[lhc/web/wiklou.git] / t / README

diff --git a/t/README b/t/README
index 3141f2c..b3b9f42 100644 (file)
--- a/t/README
+++ b/t/README
@@ -4,7 +4,49 @@ F<t> - MediaWiki test tree
 
 =head1 DESCRIPTION
 
-This is the MediaWiki test tree (well, one of them), tests here
-produce TAP output, see L<TAP>.
+This is the MediaWiki test tree (well, one of them), tests in this
+directory are self-contained programs that produce TAP output via the
+F<Test.php> module (/trunk/phase3/t/Test.php) (see
+http://search.cpan.org/~petdance/TAP-1.00/TAP.pm#THE_TAP_FORMAT for
+information on the TAP format).
+
+=head1 Running the tests
+
+To run all tests, you can run
+
+    make test
+
+Since the tests are self-contained PHP programs you can run them
+(Xml.t here) as:
+
+    php t/inc/Xml.t
+
+That'll give you the raw TAP output, but what you probably want is to
+use a TAP formatter such as L<prove(1)>:
+
+    prove t/inc/Xml.t # add -v for the verbose version
+
+or to run all the tests:
+
+   prove -r t
+
+=head1 TODO
+
+=over
+
+=item *
+
+Rewrite the rest of the F<tests/> stuff to use L<Test.php> and move it
+here
+
+=item *
+
+Make the parsertests use TAP?
+
+=item *
+
+Write unit tests for the entire codebase:)
+
+=back
 
 =cut