docs: update READMEs

git-svn-id: https://svn.apache.org/repos/asf/lucene/dev/trunk@1080424 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Yonik Seeley 2011-03-11 02:11:44 +00:00
parent 77371e0433
commit 9a847c8b8b
2 changed files with 20 additions and 16 deletions

View File

@ -17,8 +17,8 @@
Welcome to the Apache Solr project! Welcome to the Apache Solr project!
----------------------------------- -----------------------------------
Apache Solr is a search server based on the Apache Lucene search Solr is the popular, blazing fast open source enterprise search platform
library. from the Apache Lucene project.
For a complete description of the Solr project, team composition, source For a complete description of the Solr project, team composition, source
code repositories, and other details, please see the Solr web site at code repositories, and other details, please see the Solr web site at
@ -29,12 +29,20 @@ Getting Started
--------------- ---------------
See the "example" directory for an example Solr setup. A tutorial See the "example" directory for an example Solr setup. A tutorial
using the example setup can be found in "docs/tutorial.html" using the example setup can be found at
http://lucene.apache.org/solr/tutorial.html
or in in "docs/tutorial.html" in a binary distribution.
Files Included In Apache Solr Distributions Files included in an Apache Solr binary distribution
------------------------------------------- ----------------------------------------------------
example/
A self-contained example Solr instance, complete with a sample
configuration, documents to index, and the Jetty Servlet container.
Please see example/README.txt for information about running this
example.
dist/apache-solr-XX.war dist/apache-solr-XX.war
The Apache Solr Application. Deploy this WAR file to any servlet The Apache Solr Application. Deploy this WAR file to any servlet
@ -45,12 +53,6 @@ dist/apache-solr-XX.jar
Apache Solr Plugins (see http://wiki.apache.org/solr/SolrPlugins for Apache Solr Plugins (see http://wiki.apache.org/solr/SolrPlugins for
more information). more information).
example/
A self-contained example Solr instance, complete with a sample
configuration, documents to index, and the Jetty Servlet container.
Please see example/README.txt for information about running this
example.
docs/index.html docs/index.html
The contents of the Apache Solr website. The contents of the Apache Solr website.
@ -82,7 +84,7 @@ Instructions for Building Apache Solr from Source
http://lucene.apache.org/solr/version_control.html http://lucene.apache.org/solr/version_control.html
4. Navigate to that folder and issue an "ant" command to see the available options 4. Navigate to the "solr" folder and issue an "ant" command to see the available options
for building, testing, and packaging Solr. for building, testing, and packaging Solr.
NOTE: NOTE:

View File

@ -35,13 +35,15 @@ See also README.txt in the solr subdirectory, and check
http://wiki.apache.org/solr/SolrResources for a list of tutorials and http://wiki.apache.org/solr/SolrResources for a list of tutorials and
introductory articles. introductory articles.
NOTE: This Solr example server references SolrCell jars outside of the server NOTE: This Solr example server references certain Solr jars outside of
directory with <lib> statements in the solrconfig.xml. If you make a copy of this server directory for non-core modules with <lib> statements in
this example server and wish to use the ExtractingRequestHandler (SolrCell), solrconfig.xml. If you make a copy of this example server and wish
to use the ExtractingRequestHandler (SolrCell), DataImportHandler (DIH),
UIMA, the clustering component, or other modules in "contrib",
you will need to copy the required jars into solr/lib or update the paths to you will need to copy the required jars into solr/lib or update the paths to
the jars in your solrconfig.xml. the jars in your solrconfig.xml.
By default, start.jar starts Solr in Jetty using the default SolrHome By default, start.jar starts Solr in Jetty using the default solr home
directory of "./solr/" -- To run other example configurations, you can directory of "./solr/" -- To run other example configurations, you can
speciy the solr.solr.home system property when starting jetty... speciy the solr.solr.home system property when starting jetty...