mirror of
https://github.com/apache/lucene.git
synced 2025-02-07 10:38:40 +00:00
278316377c
* Improve MIGRATE.md around analyzers artifacts. Move this to the very top of MIGRATE, the user needs to first be able to pull in the artifacts, before doing anything else like trying to compile, deal with renamed classes, etc. Add a table of each package that got moved, with explicit old and new names. Hopefully it helps search engines and users. Link to MIGRATE.md explicitly from README.md
124 lines
4.7 KiB
Markdown
124 lines
4.7 KiB
Markdown
<!--
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
this work for additional information regarding copyright ownership.
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
the "License"); you may not use this file except in compliance with
|
|
the License. You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
-->
|
|
|
|
# Apache Lucene
|
|
|
|
|
|
|
|
Apache Lucene is a high-performance, full-featured text search engine library
|
|
written in Java.
|
|
|
|
[](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-main/)
|
|
|
|
## Online Documentation
|
|
|
|
This README file only contains basic setup instructions. For more
|
|
comprehensive documentation, visit:
|
|
|
|
- Latest Releases: <https://lucene.apache.org/core/documentation.html>
|
|
- Nightly: <https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-main/javadoc/>
|
|
- Build System Documentation: [help/](./help/)
|
|
- Developer Documentation: [dev-docs/](./dev-docs/)
|
|
- Migration Guide: [lucene/MIGRATE.md](./lucene/MIGRATE.md)
|
|
|
|
## Building with Gradle
|
|
|
|
### Basic steps:
|
|
|
|
0. Install OpenJDK 11 (or greater).
|
|
1. Clone Lucene's git repository (or download the source distribution).
|
|
2. 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](https://gradle.org/) 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](./help/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](https://github.com/apache/lucene/blob/main/help/IDEs.txt#L7)).
|
|
- *Netbeans* - Not tested.
|
|
|
|
## Contributing
|
|
|
|
Bug fixes, improvements and new features are always welcome!
|
|
Please review the [Contributing to Lucene
|
|
Guide](https://cwiki.apache.org/confluence/display/lucene/HowToContribute) for information on
|
|
contributing.
|
|
|
|
## Discussion and Support
|
|
|
|
- [Users Mailing List](https://lucene.apache.org/core/discussion.html#java-user-list-java-userluceneapacheorg)
|
|
- [Developers Mailing List](https://lucene.apache.org/core/discussion.html#developer-lists)
|
|
- [Issue Tracker](https://issues.apache.org/jira/browse/LUCENE)
|
|
- IRC: `#lucene` and `#lucene-dev` on freenode.net
|