Skip to content

Commit

Permalink
Cleanup readme (apache#1)
Browse files Browse the repository at this point in the history
* Basic cleanup of README
* Remove lucene DOAP file
* Change gradle rootProject.name to solr-root
* Remove badge and some more Lucene mentions. Added a link to Lucene webpage.
  • Loading branch information
janhoy authored Mar 10, 2021
1 parent 6a2294d commit 371cebd
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 1,073 deletions.
35 changes: 11 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,46 +15,34 @@
limitations under the License.
-->

# Apache Lucene and Solr
# Apache Solr

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

Apache Solr is an enterprise search platform written in Java and using Apache Lucene.
Apache Solr is an enterprise search platform written in Java and using [Apache Lucene](https://lucene.apache.org/).
Major features include full-text search, index replication and sharding, and
result faceting and highlighting.


[![Build Status](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-master/badge/icon?subject=Lucene)](https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-master/) [![Build Status](https://ci-builds.apache.org/job/Lucene/job/Solr-Artifacts-master/badge/icon?subject=Solr)](https://ci-builds.apache.org/job/Lucene/job/Solr-Artifacts-master/)
[![Build Status](https://ci-builds.apache.org/job/Lucene/job/Solr-Artifacts-master/badge/icon?subject=Solr)](https://ci-builds.apache.org/job/Lucene/job/Solr-Artifacts-master/)


## Online Documentation

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

- Lucene: <http://lucene.apache.org/core/documentation.html>
- Solr: <http://lucene.apache.org/solr/guide/>
comprehensive documentation, visit <https://solr.apache.org/guide/>

## Building with Gradle

### Building Lucene

See [lucene/BUILD.md](./lucene/BUILD.md).

### Building Solr

Firstly, you need to 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://www.oracle.com/java/ and learning
more about Java, before returning to this README. Solr runs with
Java 11 and later.

As of 9.0, Lucene/Solr uses [Gradle](https://gradle.org/) as the build
As of 9.0, Solr uses [Gradle](https://gradle.org/) as the build
system. Ant build support has been removed.

To build Lucene and Solr, run (`./` can be omitted on Windows):
To build Solr, run (`./` can be omitted on Windows):

`./gradlew assemble`

Expand Down Expand Up @@ -83,7 +71,7 @@ If you want to build the documentation, type `./gradlew -p solr documentation`.

## Running Solr

After [building Solr](#building-lucene-solr), the server can be started using
After building Solr, the server can be started using
the `bin/solr` control scripts. Solr can be run in either standalone or
distributed (SolrCloud mode).

Expand Down Expand Up @@ -114,7 +102,7 @@ directory.

`./gradlew assemble` will build a runnable Solr as noted above.

`./gradlew check` will assemble Lucene/Solr and run all validation
`./gradlew check` will assemble Solr and run all validation
tasks unit tests.

`./gradlew help` will print a list of help commands for high-level tasks. One
Expand All @@ -129,8 +117,7 @@ contributing.

## Discussion and Support

- [Users Mailing List](http://lucene.apache.org/solr/community.html#solr-user-list-solr-userluceneapacheorg)
- [Developers Mailing List](http://lucene.apache.org/solr/community.html#developer-list-devluceneapacheorg)
- [Lucene Issue Tracker](https://issues.apache.org/jira/browse/LUCENE)
- [Solr Issue Tracker](https://issues.apache.org/jira/browse/SOLR)
- [Mailing Lists](https://solr.apache.org/community.html#mailing-lists-chat)
- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
- IRC: `#solr` and `#solr-dev` on freenode.net
- [Slack](https://solr.apache.org/community.html#slack)
6 changes: 3 additions & 3 deletions dev-tools/doap/README.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
This folder contains the DOAP[1] files for each project.
This folder contains the DOAP[1] file, which is parsed and displayed at https://projects.apache.org/project.html?solr

Upon release, these files should be updated to include new release details.
Upon release, this file should be updated to include new release details.

NOTE: If this folder's contents are moved elsewhere, the website .htaccess
file will need to be updated.

[1] DOAP: https://github.com/edumbill/doap
[1] DOAP: https://github.com/edumbill/doap
Loading

0 comments on commit 371cebd

Please sign in to comment.