1<!-- 2 Licensed to the Apache Software Foundation (ASF) under one or more 3 contributor license agreements. See the NOTICE file distributed with 4 this work for additional information regarding copyright ownership. 5 The ASF licenses this file to You under the Apache License, Version 2.0 6 the "License"); you may not use this file except in compliance with 7 the License. You may obtain a copy of the License at 8 9 http://www.apache.org/licenses/LICENSE-2.0 10 11 Unless required by applicable law or agreed to in writing, software 12 distributed under the License is distributed on an "AS IS" BASIS, 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 See the License for the specific language governing permissions and 15 limitations under the License. 16 --> 17 18# Apache Lucene 19 20 21 22Apache Lucene is a high-performance, full-featured text search engine library 23written in Java. 24 25[](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-main/) 26 27## Online Documentation 28 29This README file only contains basic setup instructions. For more 30comprehensive documentation, visit: 31 32- Latest Releases: <https://lucene.apache.org/core/documentation.html> 33- Nightly: <https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-main/javadoc/> 34- Build System Documentation: [help/](./help/) 35- Developer Documentation: [dev-docs/](./dev-docs/) 36- Migration Guide: [lucene/MIGRATE.md](./lucene/MIGRATE.md) 37 38## Building 39 40### Basic steps: 41 421. Install OpenJDK 17 (exactly this version). 432. Clone Lucene's git repository (or download the source distribution). 443. Run gradle launcher script (`gradlew`). 45 46We'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. 47 48See [Contributing Guide](./CONTRIBUTING.md) for details. 49 50## Contributing 51 52Bug fixes, improvements and new features are always welcome! 53Please review the [Contributing to Lucene 54Guide](./CONTRIBUTING.md) for information on 55contributing. 56 57## Discussion and Support 58 59- [Users Mailing List](https://lucene.apache.org/core/discussion.html#java-user-list-java-userluceneapacheorg) 60- [Developers Mailing List](https://lucene.apache.org/core/discussion.html#developer-lists) 61- [Issue Tracker](https://issues.apache.org/jira/browse/LUCENE) 62- IRC: `#lucene` and `#lucene-dev` on freenode.net 63
){kind=link}