README
1CLucene README
2==============
3
4------------------------------------------------------
5CLucene is a C++ port of Lucene.
6It is a high-performance, full-featured text search
7engine written in C++. CLucene is faster than lucene
8as it is written in C++.
9------------------------------------------------------
10
11CLucene has contributions from many, see AUTHORS
12
13CLucene is distributed under the GNU Lesser General Public License (LGPL)
14 *or*
15the Apache License, Version 2.0
16See the LGPL.license and APACHE.license for the respective license information.
17Read COPYING for more about the license.
18
19
20Installation
21------------
22Read the INSTALL file
23
24
25Mailing List
26------------
27Questions and discussion should be directed to the CLucene mailing list
28 at clucene-developers@lists.sourceforge.net
29Find subscription instructions at
30 http://lists.sourceforge.net/lists/listinfo/clucene-developers
31Suggestions and bug reports can be made on our bug tracking database
32 (http://sourceforge.net/tracker/?group_id=80013&atid=558446)
33
34
35The latest version
36------------------
37Details of the latest version can be found on the CLucene sourceforge project
38web site: http://www.sourceforge.net/projects/clucene
39
40
41Documentation
42-------------
43You can build your own documentation by running 'make DoxygenDoc' from your
44'out-of-source' cmake-configured build directory.
45CLucene is a very close port of Java Lucene, so you can also try looking at the
46Java Docs on http://lucene.apache.org/java/
47There is an online version (which won't be as up to date as if you build your
48own) at http://clucene.sourceforge.net/doc/html/
49
50
51Acknowledgments
52----------------
53The Apache Lucene project is the basis for this software, so the biggest
54acknoledgment goes to that project.
55
56We wish to acknowledge the following copyrighted works that
57make up portions of the CLucene software:
58
59This software contains code derived from the RSA Data Security
60Inc. MD5 Message-Digest Algorithm.
61
62CLucene relies heavily on the use of cmake to provide a stable build environment.
63
64
README.PACKAGE
1CLucene is a C++ port of the popular Apache Lucene search engine
2(http://lucene.apache.org/java). It is released under LGPL or the Apache
3License.
4
5CLucene aims to be a high-speed alternative to Java Lucene, its API is very
6similar to that of the Java version. CLucene has recently been brought up to
7date with Lucene 2.3.2. It contains most of the same functionality as the
8Java version.
9
10This package contains the files necessary for running applications that
11use the libclucene library.
12