lucene-java-3.4.0/lucene/README.txt

   1 Apache Lucene README file
   2
   3 INTRODUCTION
   4
   5 Lucene is a Java full-text search engine.  Lucene is not a complete
   6 application, but rather a code library and API that can easily be used
   7 to add search capabilities to applications.
   8
   9 The Lucene web site is at:
  10   http://lucene.apache.org/
  11
  12 Please join the Lucene-User mailing list by sending a message to:
  13   java-user-subscribe@lucene.apache.org
  14
  15 Files in a binary distribution:
  16
  17 lucene-core-XX.jar
  18   The compiled Lucene library.
  19
  20 lucene-core-XX-javadoc.jar
  21   The Javadoc jar for the compiled Lucene library.
  22
  23 lucene-test-framework-XX.jar
  24   The compiled Lucene test-framework library.
  25   Depends on junit 4.7.x (not 4.6.x, not 4.8.x), and Apache Ant 1.7.x (not 1.6.x, not 1.8.x)
  26
  27 lucene-test-framework-XX-javadoc.jar
  28   The Javadoc jar for the compiled Lucene test-framework library.
  29
  30 contrib/demo/lucene-demo-XX.jar
  31   The compiled simple example code.
  32
  33 contrib/*
  34   Contributed code which extends and enhances Lucene, but is not
  35   part of the core library.  Of special note are the JAR files in the analyzers directory which
  36   contain various analyzers that people may find useful in place of the StandardAnalyzer.
  37
  38 docs/index.html
  39   The contents of the Lucene website.
  40
  41 docs/api/index.html
  42   The Javadoc Lucene API documentation.  This includes the core library,
  43   the test framework, and the demo, as well as all of the contrib modules.