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,450 Commits 28 Branches 466 Tags 739 MiB
Java 97.7%
HTML 1%
Python 0.8%
Lex 0.3%
Go to file
Dawid Weiss 1d152c5f67 LUCENE-10192: drop jars from binary distribution and an aggregate merge of related minor tasks. 2021-10-31 10:50:11 +01:00
.github LUCENE-10209: Temporarily comment out gradle validation. 2021-10-27 21:12:14 +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-10192: Use modules instead of classpath for binary distribution testing. 2021-10-31 10:41:49 +01:00
gradle LUCENE-10200: Rename pddl-10.txt to reference glove. 2021-10-31 10:41:16 +01:00
help LUCENE-9660: correct help/tests.txt. 2021-10-26 08:45:58 +02:00
lucene LUCENE-10213: Use unicode escapes in message property files in Luke (remove hacks) 2021-10-31 10:41:54 +01: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: clean up and remove some old cruft in readme files. Move binary release only README.md to the distribution project so that it doesn't look weird in the source tree. (#406) 2021-10-26 21:20:42 +02:00
build.gradle LUCENE-9488: rewrite distribution assembly, signing and checksum generation (#372) 2021-10-13 11:50:58 +02: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-9488: rewrite distribution assembly, signing and checksum generation (#372) 2021-10-13 11:50:58 +02:00
versions.lock LUCENE-10201: Upgrade Spatial4j to 0.8 (#409) 2021-10-29 22:01:52 -04:00
versions.props LUCENE-10201: Upgrade Spatial4j to 0.8 (#409) 2021-10-29 22:01:52 -04: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).
  2. Clone Lucene's git repository (or download the source distribution).
  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 jvms.txt for more information.

NOTE: Lucene changed from Apache Ant to Gradle as of release 9.0. Prior releases still use Apache 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 the source 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 the gradle command that is perhaps installed on your machine. This may result in using a different gradle version than the project requires and this is known to lead to very cryptic errors. The "gradle wrapper" (gradlew script) does everything required to build the project from scratch: it downloads the correct version of gradle, sets up sane local configurations and is tested on multiple environments.

The first time you run gradlew, 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 tests).

./gradlew help will print a list of help guides that introduce and explain various parts of the build system, including typical workflow tasks.

If you want to just build the documentation, type:

./gradlew documentation

IDE support

  • IntelliJ - IntelliJ idea can import and build gradle-based projects 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