2012-04-22 17:15:27 -04:00
|
|
|
# Apache Lucene README file
|
2001-11-04 12:23:04 -05:00
|
|
|
|
2012-04-22 17:15:27 -04:00
|
|
|
## Introduction
|
2001-11-04 12:23:04 -05:00
|
|
|
|
|
|
|
Lucene is a Java full-text search engine. Lucene is not a complete
|
|
|
|
application, but rather a code library and API that can easily be used
|
|
|
|
to add search capabilities to applications.
|
|
|
|
|
2012-04-22 17:15:27 -04:00
|
|
|
* The Lucene web site is at: http://lucene.apache.org/
|
|
|
|
* Please join the Lucene-User mailing list by sending a message to:
|
|
|
|
java-user-subscribe@lucene.apache.org
|
2001-11-04 12:23:04 -05:00
|
|
|
|
2012-04-22 17:15:27 -04:00
|
|
|
## Files in a binary distribution
|
2001-11-04 12:23:04 -05:00
|
|
|
|
2012-04-17 15:52:48 -04:00
|
|
|
Files are organized by module, for example in core/:
|
|
|
|
|
2012-04-22 17:15:27 -04:00
|
|
|
* `core/lucene-core-XX.jar`:
|
2012-04-17 15:52:48 -04:00
|
|
|
The compiled core Lucene library.
|
|
|
|
|
2012-04-22 17:15:27 -04:00
|
|
|
To review the documentation, read the main documentation page, located at:
|
|
|
|
`docs/index.html`
|
2012-09-27 11:57:30 -04:00
|
|
|
|
|
|
|
To build Lucene or its documentation for a source distribution, see BUILD.txt
|