1 files changed, 78 insertions, 0 deletions
diff --git a/vo/votest/README b/vo/votest/README
new file mode 100644
index 00000000..0845878d
--- /dev/null
+++ b/vo/votest/README
@@ -0,0 +1,78 @@
+
+
+			VO Test Package
+
+    The VOTEST package allows users and developers to create simple scripts
+that can be used to run a regression test on the package after changes to
+system interfaces, test for specific problems to be sure they done recur,
+and the ensure that the help examples continue to function as specified.
+
+This directory contains the following:
+
+	README			This file
+
+	data/			Sample data directory
+	tests/			Test script directory
+
+	run_test.cl		Utility task to execute a single test
+	test.cl			Main test script
+
+	votest.cl		Standard package files
+	votest.hd
+	votest.men
+	votest.par
+	doc/			Task documentation directory
+	
+
+Test Script Usage:
+------------------
+
+    The package defines a single (visible) task call TEST with the following
+usage:
+
+	cl> test [<module>] [list] [verbose]
+
+where
+	module		Either 'all' or the name of a specific test module
+	list		If set, list available tests only
+	verbose		Print verbose output
+
+If no parameters are specified, all tests are run.
+
+
+To Add A New Test:
+------------------
+
+    Test scripts are placed in the 'tests' subdirectory and are expected to
+follow the following conventions:
+
+    1) A description of tests in a "module" is contained in a file 'module.men'
+       and should contain something like
+
+	    #  Module Tests -- Tests of the stuff needing testing
+
+	           module_001 -- test 1 description
+	           module_002 -- test 2 description
+		       :	      :   :     :
+	           module_NNN -- test N description
+
+	Lines beginning with a '#' will be used to comment the tests being run.
+ 
+    2) A module test script contains commands to be executes.  It *should*
+       also set the "votest.descr" parameter to be some short description
+       of the test, this text is printed when the test is run.  Test scripts
+       should be named using the convention 'module_NNN.cl' where "module" is
+       the common module name, "NNN" is some running number for the test, and
+       the script is expected to have a ".cl" filename extension.
+
+    3) A module test script that produces any form of output should have the
+       expected output in a file called "module_NNN.out".  A test is deemed to
+       have passed when a diff of this file with the output of the test script
+       produces no output (i.e. no differences).
+
+    4) A "test module" is comprised of all the above ".men", ".cl" and ".out" 
+       files.  Typically tests will be grouped by some common these, e.g. a
+       particular task or feature of the system to be tested.
+
+The TEST task will automatically execute any scripts in the 'tests' directory,
+minimizing the amount of changes required to add a new test.