X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=README;h=7f3b4f1fec10f8c60008308a455ceb74ab8e6ad4;hb=738438f3da478a1d0121cbbdab620c47f222c73e;hp=ae27147fa244384086bd2c0e5af53cb992961036;hpb=b8a3e097b6ce2a08137e9eba5c6bcbdf9050e9dd;p=cql-java-moved-to-github.git diff --git a/README b/README index ae27147..7f3b4f1 100644 --- a/README +++ b/README @@ -1,12 +1,11 @@ -$Id: README,v 1.20 2002-11-18 15:05:49 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.) @@ -16,34 +15,49 @@ cql-java is a Free Software project that provides: * 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/cql/xcql.html -include an XML Schema. +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 + Changes History of releases + LGPL-2.1 The GNU lesser GPL (see below) + 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 @@ -53,7 +67,7 @@ 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 '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 @@ -82,15 +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 ------ -All code and documentation by Mike Taylor - http://www.miketaylor.org.uk +Original code and documentation by Mike Taylor, Index Data +At present maintained by Jakub Skoczen, Index Data + + 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. @@ -98,18 +116,19 @@ stories and, of course, large cash donations. LICENCE ------- -The cql-java suite is Free Software, which is pretty much legally +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 +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 deploy -cql-java as a part of a non-free larger work. +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 @@ -117,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.