First more or less functional version of the test suite

[cql-java-moved-to-github.git] / README

diff --git a/README b/README
index 590fff1..1cd2bd9 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,4 @@
-$Id: README,v 1.6 2002-10-30 11:13:18 mike Exp $
+$Id: README,v 1.8 2002-11-01 23:45:28 mike Exp $
 
 cql-java -- a free CQL compiler for Java
 
@@ -53,8 +53,8 @@ Library:
 DESCRIPTION
 -----------
 
-Se the automatically generated class documentation in the "doc"
-subdirectory.  (### It's not there yet, of course)
+See the automatically generated class documentation in the "doc"
+subdirectory.  (It's not all there yet, but it's coming.)
 
 
 AUTHOR
@@ -72,6 +72,19 @@ licence to use.  Be good.  Assume I'm going with the GPL (most
 restrictive) until I say otherwise.
 
 
+TESTING
+-------
+
+Ways of testing the parser and other components include:
+
+* Generate a random tree with CQLGenerate, take a copy, and
+  canonicalise it with CQLparser -c.  Since the CQLGenerate output is
+  in canonical form anyway, the before-and-after versions should be
+  identical.
+
+* ... others :-)
+
+
 SEE ALSO
 --------
 
@@ -83,21 +96,22 @@ All the other free CQL compilers everyone's going to write  :-)
 TO DO
 -----
 
-* Add proximity support to parser
+* Allow CQLGenerate test-harness to take some of its configuration
+  parameters on the command-line as well as or instead of a file.
 
-* Some niceties for the CQL-decompiling back-end:
-       * Don't emit redundant parentheses.
-       * Don't put spaces around relations that don't need them.
+* Some niceties for the cql-decompiling back-end:
+       * don't emit redundant parentheses.
+       * don't put spaces around relations that don't need them.
 
-* Write PQN-generating back-end (will need to be driven from a
+* Write pqn-generating back-end (will need to be driven from a
   configuation file specifying how to represent the qualifiers,
-  relations, relation modifiers and wildcard characters as Z39.50
+  relations, relation modifiers and wildcard characters as z39.50
   attributes.)
 
 * Consider the utility of yet another back-end that translates a
   CQLNode tree into a Type-1 query tree using the JZKit data
   structures.  That would be nice so that CQL could become a JZKit
-  query-type, but you could achieve the same effect by generating PQN,
+  query-type; but you could achieve the same effect by generating PQN,
   and running that through JZKit's existing PQN-to-Type-1 compiler.
 
 * Refinements to random query generator:
@@ -113,6 +127,3 @@ TO DO
 
 * Write generic test suite.
 
-* Fix CQLParser test harness to read query from command-line
-  arguments, if any, falling back to stdin if there are none.
-