lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [46/58] [abbrv] lucene-solr:jira/solr-10879: LUCENE-5822 Add markdown-compatible
Date Mon, 03 Jul 2017 11:58:26 GMT
LUCENE-5822 Add markdown-compatible

Signed-off-by: Mike Drob <>


Branch: refs/heads/jira/solr-10879
Commit: 2e1c5063a5cdd76098730265dc551c43ad8526ae
Parents: 15118d4
Author: Jason Gerlowski <>
Authored: Tue Jun 27 18:04:15 2017 -0400
Committer: Mike Drob <>
Committed: Fri Jun 30 10:57:09 2017 -0500

----------------------------------------------------------------------          | 103 ++++++++++++++++++++++++++++++++++++++++++++++++
 README.txt         |  13 ------
 lucene/CHANGES.txt |   2 +
 3 files changed, 105 insertions(+), 13 deletions(-)
diff --git a/ b/
new file mode 100644
index 0000000..7181297
--- /dev/null
+++ b/
@@ -0,0 +1,103 @@
+    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
+    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 and Solr
+Apache Lucene is a high-performance, full featured text search engine library
+written in Java.
+Apache Solr is an enterprise search platform written using Apache Lucene.
+Major features include full-text search, index replication and sharding, and
+result faceting and highlighting.
+## Online Documentation
+This README file only contains basic setup instructions.  For more
+comprehensive documentation, visit:
+- Lucene: <>
+- Solr: <>
+## Building Lucene/Solr
+(You do not need to do this if you downloaded a pre-built package.)
+Lucene and Solr are built using [Apache Ant](  To build
+Lucene and Solr, run:
+`ant compile`
+The Solr server can then be packaged and prepared for startup by running the
+following command from the `solr/` directory:
+`ant server`
+## Running Solr
+After [building Solr](#building-lucene-solr), the server can be started using
+the `bin/solr` control scripts.  Solr can be run in either standalone or
+distributed (SolrCloud mode).
+To run Solr in standalone mode, run the following command from the `solr/`
+`bin/solr start`
+To run Solr in SolrCloud mode, run the following command from the `solr/`
+`bin/solr start -c`
+The `bin/solr` control script allows heavy modification of the started Solr.
+Common options are described in some detail in solr/README.txt.  For an
+exhaustive treatment of options, run `bin/solr start -h` from the `solr/`
+## Development/IDEs
+Ant can be used to generate project files compatible with most common IDEs.
+Run the ant command corresponding to your IDE of choice before attempting to
+import Lucene/Solr.
+- *Eclipse* - `ant eclipse`
+- *IntelliJ* - `ant idea`
+- *Netbeans* - `ant netbeans`
+## Running Tests
+The standard test suite can be run with the command:
+`ant test`
+Like Solr itself, the test-running can be customized or tailored in a number or
+ways.  For an exhaustive discussion of the options available, run:
+`ant test-help`
+## Contributing
+Please review the [Contributing to Solr
+Guide]( for information on
+## Discussion and Support
+- [Users Mailing List](
+- [Developers Mailing List](
+- [Lucene Issue Tracker](
+- [Solr Issue Tracker](
+- IRC: `#solr` and `#solr-dev` on
diff --git a/README.txt b/README.txt
deleted file mode 100644
index 3599b5b..0000000
--- a/README.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-Apache Lucene/Solr
-lucene/ is a search engine library
-solr/ is a search engine server that uses lucene
-To compile the sources run 'ant compile'
-To run all the tests run 'ant test'
-To setup your ide run 'ant idea', 'ant netbeans', or 'ant eclipse'
-For Maven info, see dev-tools/maven/README.maven
-For more information on how to contribute see:
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
index 69ba53f..909b6ce 100644
--- a/lucene/CHANGES.txt
+++ b/lucene/CHANGES.txt
@@ -167,6 +167,8 @@ Other
   resolved against Lucene's class loader by default. Please use another builder
   method to change to a custom classloader.  (Uwe Schindler)
+* LUCENE-5822: Convert README to Markdown (Jason Gerlowski via Mike Drob)
 ======================= Lucene 6.7.0 =======================
 New Features

View raw message