Add classes for visitor traversal

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

diff --git a/README b/README
index 0097fbf..7f3b4f1 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,3 @@
-$Id: README,v 1.23 2007-06-06 14:42:53 mike Exp $
 
 CQL-Java - a free CQL compiler, and other CQL tools, for Java
 
@@ -38,19 +37,27 @@ WHAT'S WHAT IN THIS DISTRIBUTION?
 ---------------------------------
 
        README          This file
-       VERSION         The version-number of this distribution
        Changes         History of releases
        LGPL-2.1        The GNU lesser GPL (see below)
-       Makefile, Build Files to control compilation.
-       src             Source-code for the CQL-Java library
-       lib             The compiled library file, "cql-java.jar"
-       bin             Simple shell-scripts to invoke the test-harnesses
-       docs            Documentation automatically generated by "javadoc"
-       test            Various testing and sanity-checking frameworks
-       etc             Other files: CQL Grammar, generator properties, etc.
+       pom.xml Maven project file to control compilation.
+       src     Source-code for the CQL-Java library and tests
+       target  The compiled library file, "cql-java.jar" and javadoc
+       bin     Simple shell-scripts to invoke CQL programs (parser/lexer/generator)
+       util    Various testing and sanity-checking Perl scripts
+       etc             Other files: PQF indexes, generator properties, etc.
+
+
+COMPILATION AND INSTALLATION
+----------------------------
+
+The build process is controlled by Maven so compilation is the standard:
+
+  mvn clean install
+
+which generates build artifacts under target/.
 
 "Installation" of this package would consist of putting the bin
-directory on your PATH and lib/cql-java.jar on your CLASSPATH.
+directory on your PATH and target/cql-java.jar on your CLASSPATH.
 
 
 SYNOPSIS
@@ -89,16 +96,19 @@ Using the library in your own applications:
 DESCRIPTION
 -----------
 
-See the automatically generated class documentation in the "doc"
+See the automatically generated class documentation in the "target"
 subdirectory.
 
 
 AUTHOR
 ------
 
-Code and documentation by Mike Taylor, Index Data <mike@indexdata.com>
-       http://indexdata.com
+Original code and documentation by Mike Taylor, Index Data <mike@indexdata.com>
+At present maintained by Jakub Skoczen, Index Data <jakub@indexdata.dk>
+
+    http://www.indexdata.com/cql-java
        http://zing.z3950.org/cql
+
 Please email me with bug-reports, wishlist items, patches, deployment
 stories and, of course, large cash donations.
 
@@ -126,5 +136,6 @@ SEE ALSO
 
 Adam Dickmeiss's CQL compiler, written in C.
 Rob Sanderson's CQL compiler, written in Python.
+Jakub Skoczen's CQL-js compiler, written in JavaScript http://git.indexdata.com/?p=cql-js.git
 All the other free CQL compilers everyone's going to write  :-)
 The "Changes" file, including the "Still to do" section.