More clean up, update readme

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

diff --git a/util/random/README b/util/random/README
new file mode 100644 (file)
index 0000000..586796b
--- /dev/null
+++ b/util/random/README
@@ -0,0 +1,14 @@
+
+In this directory, we test the integrity of the CQL-Java tools as
+follows:
+
+* Generate a random tree with CQLGenerate
+* Take a copy
+* Canonicalise it with CQLparser -c.
+* Compare the before-and-after versions.
+
+Since the CQLGenerate output is in canonical form anyway, the
+before-and-after versions should be identical.  This process exercises
+the comprehensiveness and bullet-proofing of the parser, as well as
+the accuracy of the rendering.
+