README

Lucene "Did you mean?" Implementation
================================================================================

DISCLAIMER: The code is very much work in progress and is not expected to work!

About
-----
This package is based on Karl Wettin's 'didyoumean' contrib module for Lucene
found on http://issues.apache.org/jira/browse/LUCENE-626

In January 2010 Mikkel Kamstrup Erlandsen, on behalf of the State and University
Library of Denmark, started forward porting Karl's code to Lucene trunk and
abstracting out the BDB dependency.

Compiling
---------
To compile it place this 'didyoumean' directory under the contrib/ directory
inside the Lucene source tree. Then build lucene by running 'ant'.

Next you need to build the 'instantiated' contrib package. Go into the
contrin/instantiated/ and run 'ant'.

Now change directory to contrib/didyoumean/ and run 'ant'.

Running
-------
In order use this library you must have lucene-core-$VERSION.jar,
lucene-instantiated-$VERSION.jar, and lucene-didyoumean-$VERSION.jar
in you classpath