Skip to content

Latest commit

 

History

History
102 lines (59 loc) · 3.03 KB

README.rst

File metadata and controls

102 lines (59 loc) · 3.03 KB
Raw

Lucene++

Welcome to lucene++ version 3.0.7.

Lucene++ is an up to date C++ port of the popular Java Lucene library, a high-performance, full-featured text search engine.

Components

  • liblucene++ library
  • liblucene++-contrib library
  • lucene++-tester (unit tester)
  • deletefiles (demo)
  • indexfiles (demo)
  • searchfiles (demo)

Useful Resources

Official Java Lucene - useful links and documentation relevant to Lucene and lucene++. Lucene in Action by Otis Gospodnetic and Erik Hatcher.

Build Instructions

You'll need the Boost libraries installed somewhere.

On Debian systems, the following packages are required:

  • libboost-date-time-dev
  • libboost-filesystem-dev
  • libboost-regex-dev
  • libboost-thread-dev
  • libboost-iostreams-dev

To build the library the following commands should be issued:

$ mkdir build; cd build
$ cmake ..
$ make
$ make install

Build Instructions for Windows systems

Open solution lucene++.sln located in the msvc folder into Visual Studio 2010+ and build.

Note: you will need to edit the includeConfig.h.cmake file. Make a copy, rename it to Config.h, and replace

#@DEFINE_USE_CYCLIC_CHECK@ LPP_USE_CYCLIC_CHECK

with

#define LPP_USE_CYCLIC_CHECK

Note: "BOOST_ROOT" environment variable must be defined to point to the Boost library directory (eg. c:\boost_1_57_0)

Boost libs must be located in a subdirectory lib32-msvc-10.0 This is the default name of the install directory from the sf.net Boost-binaries project.

You'll need Boost installed from http://boost.org.

To run unit test suite

lucene_tester is built using the Google Testing Framework and is launched by the following command:

$ build/src/test/lucene++-tester

Command options can be discovered by supplying --help.

To run the demos

Start by indexing a directory of files - open a command prompt and run

indexfiles.exe <directory to index> <directory to store index>

Once the indexer has finished, you can query the index using searchfiles

searchfiles.exe -index <directory you stored the index in>

This uses an interactive command for you to enter queries, type a query to search the index press enter and you'll see the results.

Acknowledgements