LuceneKit
=========

:Maintainer: Yen-Ju Chen <yjchenx at gmail dot com>
:Authors: Yen-Ju Chen, Quentin Mathe, Manuel Guesdon
:License: Apache License 2.0
:Version: 0.1.1

Lucene is a high-performance, full-featured text search engine library. It is a 
technology suitable for nearly any application that requires full-text search.

This is a GNUstep port of Lucene <http://lucene.apache.org/>.

To know more about LuceneKit: 
<http://www.etoile-project.org/dev/0.4/LuceneKit>


Build and Install
-----------------

Read INSTALL document.


Mac OS X support
----------------

LuceneKit is compatible with Cocoa (Xcode project included, but currently 
untested and outdated).
It is possible to use it as a convenient SearchKit replacement, LuceneKit is
cross-platform and written in Objective-C, unlike SearchKit which is a Carbon 
framework.


Developer notes
===============

Tests suite
-----------

UnitKit (bundled with Etoile) is required.

   Steps to produce a test bundle and run tests suite:

    * make test=yes 

    * ukrun


Contribute 
----------

Read TODO document.
