Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Apache Lucene open-source search software
35,412 Commits 27 Branches 467 Tags 735 MiB
Java 97.7%
HTML 1%
Python 0.9%
Lex 0.3%
Go to file
Tomoko Uchida 54418cef45
LUCENE-9997: write release revision to system temp dir (#394) 		2021-10-20 07:06:30 +09:00
.github LUCENE-10167: Run tests on PRs (and pushes to the main branch) (#376) 2021-10-12 15:19:34 +02:00
.muse SOLR-14883 Add a Muse (Continuous assurance platform) configuration (#1901) 2020-09-23 17:42:19 -07:00
buildSrc LUCENE-9488: rewrite distribution assembly, signing and checksum generation (#372) 2021-10-13 11:50:58 +02:00
dev-docs SOLR-15160 update cloud.sh (#2393) 2021-02-21 14:36:19 -05:00
dev-tools LUCENE-9997: write release revision to system temp dir (#394) 2021-10-20 07:06:30 +09:00
gradle LUCENE-10186: Include manifest and legalese in source and javadoc jars. (#395) 2021-10-19 10:04:42 +02:00
help Fix typo 2021-10-14 13:28:10 -05:00
lucene LUCENE-10182: Order assertion parameters correctly (#397) 2021-10-19 16:29:46 +02: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-9077: make git always keep .gradle files with LF EOLs. 2020-04-09 13:55:16 +02: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
LICENSE.txt LUCENE-10163 Move LICENSE and NOTICE file to top level (#388) 2021-10-18 01:24:11 +02:00
NOTICE.txt LUCENE-10166: removed module-level README.txt and modified a few links, removed a few obsolete instructions from 20 years ago. (#379) 2021-10-19 09:45:49 +02:00
README.md LUCENE-10163 Move LICENSE and NOTICE file to top level (#388) 2021-10-18 01:24:11 +02:00
build.gradle LUCENE-9488: rewrite distribution assembly, signing and checksum generation (#372) 2021-10-13 11:50:58 +02:00
gradlew Gradle hotfix in preparation for Jenkins: Fix for whitespace in directory violations 2020-08-23 17:51:11 +02:00
gradlew.bat Upgrade gradle to 7.1.1 2021-08-25 10:03:59 +02:00
settings.gradle LUCENE-9488: rewrite distribution assembly, signing and checksum generation (#372) 2021-10-13 11:50:58 +02:00
versions.lock LUCENE-10164: lucene/replicator should only have jetty as a test dependency (#373) 2021-10-11 13:53:58 -04:00
versions.props LUCENE-9654: Expressions module gramar antlr code regeneration (#269) 2021-08-27 12:47:19 +02: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 with Gradle

Basic steps:

  1. Install OpenJDK 11 (or greater up until version 15)
  2. Download Lucene from Apache and unpack it (or clone the git repository).
  3. Run gradle launcher script (gradlew).

Step 0) Set up your development environment (OpenJDK 11 or greater)

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. Lucene runs with Java 11 or later.

Lucene uses Gradle for build control. Gradle is itself Java-based and may be incompatible with newer Java versions; you can still build and test Lucene with these Java releases, see help/tests.txt for more information.

NOTE: Lucene changed from Ant to Gradle as of release 9.0. Prior releases still use Ant.

Step 1) Checkout/Download Lucene source code

You can clone the source code from GitHub:

https://github.com/apache/lucene

or get Lucene source archives for a particular release from:

https://lucene.apache.org/core/downloads.html

Download either a zip or a tarred/gzipped version of the archive, and uncompress it into a directory of your choice.

Step 2) Run Gradle

Run "./gradlew help", this will show the main tasks that can be executed to show help sub-topics.

If you want to build Lucene, type:

./gradlew assemble

NOTE: DO NOT use gradle command that is already installed on your machine (unless you know what you'll do). The "gradle wrapper" (gradlew) does the job - downloads the correct version of it, setups necessary configurations.

The first time you run Gradle, it will create a file "gradle.properties" that contains machine-specific settings. Normally you can use this file as-is, but it can be modified if necessary.

./gradlew check will assemble Lucene and run all validation tasks (including unit tests).

./gradlew help will print a list of help guides that help understand how the build and typical workflow works.

If you want to build the documentation, type:

./gradlew documentation

Gradle build and IDE support

  • IntelliJ - IntelliJ idea can import the project out of the box.
  • Eclipse - Basic support (help/IDEs.txt).
  • Netbeans - Not tested.

Contributing

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

Discussion and Support