Apache Lucene open-source search software
Go to file
Tomoko Uchida ac6c36d406
LUCENE-10184: add CONTRIBUTING.md; reorganize README. (#771)
2022-03-29 16:52:27 +09:00
.github migrate to temurin (#697) 2022-02-21 17:09:21 +09:00
.muse SOLR-14883 Add a Muse (Continuous assurance platform) configuration (#1901) 2020-09-23 17:42:19 -07:00
buildSrc LUCENE-10419: upgrade rat to 0.13. 2022-02-10 17:37:06 +01:00
dev-docs Add documentation on file formats. (#598) 2022-01-11 15:16:05 +01:00
dev-tools DOAP changes for release 9.1.0 2022-03-22 15:22:27 +01:00
gradle Upgrade to forbiddenapis 3.3 (#768) 2022-03-26 17:09:42 +01:00
help LUCENE-9660: correct help/tests.txt. 2021-10-26 08:45:58 +02:00
lucene Add CHANGES entry for LUCENE-10325 2022-03-28 15:57:18 -07:00
.asf.yaml titles for github 2021-03-10 12:51:06 +01:00
.dir-locals.el LUCENE-9322: Add Lucene90 codec, including VectorFormat 2020-10-18 07:49:36 -04:00
.git-blame-ignore-revs LUCENE-9570: code reformatting [record rev]. 2021-01-05 13:44:42 +01:00
.gitattributes LUCENE-10305: Ensure line endings of versions.props is LF 2021-12-11 10:10:44 +09:00
.gitignore LUCENE-9920: Remove binary gradle-wrapper.jar from the repository 2021-04-10 16:08:39 +02:00
.hgignore LUCENE-2792: add FST impl 2010-12-12 15:36:08 +00:00
CONTRIBUTING.md LUCENE-10184: add CONTRIBUTING.md; reorganize README. (#771) 2022-03-29 16:52:27 +09:00
LICENSE.txt LUCENE-10163 Move LICENSE and NOTICE file to top level (#388) 2021-10-18 01:24:11 +02:00
NOTICE.txt LUCENE-10416: Update Korean Dictionary to mecab-ko-dic-2.1.1-20180720 for Nori 2022-02-20 21:39:03 +09:00
README.md LUCENE-10184: add CONTRIBUTING.md; reorganize README. (#771) 2022-03-29 16:52:27 +09:00
build.gradle Upgrade to forbiddenapis 3.3 (#768) 2022-03-26 17:09:42 +01:00
gradlew LUCENE-10198: remove debug statement that crept in. 2021-10-26 21:33:19 +02:00
gradlew.bat LUCENE-10198: Allow external JAVA_OPTS in gradlew scripts; use sane defaults (heap, stack and system proxies) (#405) 2021-10-26 09:15:55 +02:00
settings.gradle LUCENE-10328: Module path for compiling and running tests is wrong (#571) 2022-01-05 20:42:02 +01:00
versions.lock LUCENE-8930: script testing in the distribution (#550) 2022-01-20 00:09:15 +09:00
versions.props LUCENE-8930: script testing in the distribution (#550) 2022-01-20 00:09:15 +09:00

README.md

Apache Lucene

Lucene Logo

Apache Lucene is a high-performance, full-featured text search engine library written in Java.

Build Status

Online Documentation

This README file only contains basic setup instructions. For more comprehensive documentation, visit:

Building

Basic steps:

  1. Install OpenJDK 17 (or greater).
  2. Clone Lucene's git repository (or download the source distribution).
  3. Run gradle launcher script (gradlew).

We'll assume that you know how to get and set up the JDK - if you don't, then we suggest starting at https://jdk.java.net/ and learning more about Java, before returning to this README.

See Contributing Guide for details.

Contributing

Bug fixes, improvements and new features are always welcome! Please review the Contributing to Lucene Guide for information on contributing.

Discussion and Support