summaryrefslogtreecommitdiff
path: root/manual/xmlformat/README
diff options
context:
space:
mode:
Diffstat (limited to 'manual/xmlformat/README')
-rw-r--r--manual/xmlformat/README35
1 files changed, 35 insertions, 0 deletions
diff --git a/manual/xmlformat/README b/manual/xmlformat/README
new file mode 100644
index 0000000000..53c4ff6c53
--- /dev/null
+++ b/manual/xmlformat/README
@@ -0,0 +1,35 @@
+xmlformat - an XML document formatter
+
+Paul DuBois
+paul@kitebird.com
+
+This is the distribution for xmlformat 1.04.
+If you find bugs, please let me know.
+
+The current version of xmlformat is always available at:
+ http://www.kitebird.com/software/
+
+xmlformat is free software, distributed under a BSD-style license.
+For specific licensing information, see the LICENSE file.
+
+For installation instructions, see the INSTALL file. xmlformat has two
+implementations, one in Ruby and one in Perl. They should produce
+identical output in all cases.
+
+Documentation is in the docs subdirectory.
+
+Tests are in the tests directory, though you run them in the main
+xmlformat directory:
+- To run all tests:
+ make test
+- To run all tests for the Ruby version:
+ ./runtest all
+- To run all tests for the Perl version:
+ ./runtest -p all
+- To run an individual test for the Ruby version:
+ ./runtest testname
+- To run an individual test for the Perl version:
+ ./runtest -p testname
+
+A test name is the name of its .xml file, minus the .xml suffix.
+For more information, see tests/Notes.