-$Id: README,v 1.18 2002-11-14 22:04:16 mike Exp $
+$Id: README,v 1.24 2007-06-07 16:04:50 mike Exp $
-cql-java - a free CQL compiler, and other CQL tools, for Java
+CQL-Java - a free CQL compiler, and other CQL tools, for Java
INTRODUCTION
------------
-cql-java is a Free Software project that provides:
+CQL-Java is a Free Software project that provides:
* A set of classes for representing a CQL parse tree (a base CQLNode
class, CQLBooleanNode and its subclasses, CQLTermNode, etc.)
* XCQL (the standard XML representation)
* CQL (i.e. decompiling the parse-tree)
* PQF (Yaz-style Prefix Query Format)
+ * BER code for the Z39.50 Type-1 query
* A random query generator, useful for testing.
-CQL is "Common Query Language", a new query language designed under
+CQL is "Common Query Language", a query language designed under
the umbrella of the ZING initiative (Z39.59-International Next
-Generation). More information at
+Generation). The official specification is at
+ http://www.loc.gov/standards/sru/cql/
+and there's more (and friendlier) information at
http://zing.z3950.org/cql/index.html
XCQL is "XML CQL", a representation of CQL-equivalent queries in XML
-which is supposed to be easier to parse. More information at
- http://www.loc.gov/z3950/agency/zing/srwu/xcql.html
-(not much more, though)
+which is supposed to be easier to parse. The specification is at
+ http://www.loc.gov/standards/sru/xml-files/xcql.xsd
+in the form of an XML Schema.
But if you didn't know that, why are you even reading this? :-)
-What's what in this distribution?
+WHAT'S WHAT IN THIS DISTRIBUTION?
+---------------------------------
- README This file
- VERSION The version-number of this distribution
- 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.
+ 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: PQF indexes, generator properties, etc.
"Installation" of this package would consist of putting the bin
directory on your PATH and lib/cql-java.jar on your CLASSPATH.
Using the test-harnesses:
$ CQLParser 'title=foo and author=(bar or baz)'
+ $ CQLParser -c 'title=foo and author=(bar or baz)'
+ $ CQLParser -p /etc/pqf.properties 'dc.title=foo and dc.author=bar'
$ CQLLexer 'title=foo and author=(bar or baz)'
(not very interesting unless you're debugging)
$ CQLGenerator etc/generate.properties seed 18
AUTHOR
------
-All code and documentation by Mike Taylor <mike@z3950.org>
- http://www.miketaylor.org.uk
+Code and documentation by Mike Taylor, Index Data <mike@indexdata.com>
+ http://indexdata.com
+ http://zing.z3950.org/cql
Please email me with bug-reports, wishlist items, patches, deployment
stories and, of course, large cash donations.
LICENCE
-------
-This software is Open Source, but I've not yet decided exactly what
-licence to use. Be good. Assume I'm going with the GPL (most
-restrictive) until I say otherwise. For what it's worth, I think the
-most likely licence is the LGPL (GNU's Lesser General Public Licence)
-which lets you deploy cql-java as a part of a non-free larger work.
+The CQL-Java suite is Free Software, which is pretty much legally
+equivalent -- though not morally equivalent -- to Open Source. See
+ http://www.gnu.org/philosophy/free-software-for-freedom.html
+for a detailed if somewhat one-sided discussion of the differences,
+and particularly of why Free Software is an important idea.
+
+CQL-Java is distributed under version 2.1 of the LGPL (GNU LESSER
+GENERAL PUBLIC LICENSE). A copy of the licence is included in this
+distribution, as the file LGPL-2.1. This licence does not allow you
+to restrict the freedom of others to use derived versions of CQL-Java
+(i.e. you must share your enhancements), but does let you do pretty
+much anything else with it. In particular, you may deploy CQL-Java as
+a part of a non-free larger work.
SEE ALSO
Adam Dickmeiss's CQL compiler, written in C.
Rob Sanderson's CQL compiler, written in Python.
All the other free CQL compilers everyone's going to write :-)
-
-
-THINGS TO DO
-------------
-
-[See the final "Still to do" section of the "Changes" file.]
-
+The "Changes" file, including the "Still to do" section.