summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Baumann <abaumann@yahoo.com>2012-08-15 08:53:04 +0200
committerAndreas Baumann <abaumann@yahoo.com>2012-08-15 08:53:04 +0200
commit96fbfca3b09682b61220cfe7f8f5071781eb365b (patch)
treee790e9070ffda37f97e47315212635e1a5c6a5b7
parent05f101e6770d57751ea1e558cea359abab3cbb6d (diff)
downloadLuceneAnalyzer-96fbfca3b09682b61220cfe7f8f5071781eb365b.tar.gz
LuceneAnalyzer-96fbfca3b09682b61220cfe7f8f5071781eb365b.tar.bz2
updated README
-rw-r--r--README.txt17
1 files changed, 16 insertions, 1 deletions
diff --git a/README.txt b/README.txt
index 74e4320..34764cc 100644
--- a/README.txt
+++ b/README.txt
@@ -1,5 +1,20 @@
-Required software:
+Dumps a Lucene or SolR index in the shell in tab-separated lines.
+This is useful for statistics or debugging a Lucene or SolR-based
+project.
+
+Currently the SolR support is crude and far from complete.
+
+Build
+-----
+
+mvn clean install package
+
+Requirements
+------------
+
+- maven (to build the project)
- lucene-core (comes in pom.xml)
+- solr-core (comes in pom.xml)
- jargs (somehow not in a Maven repository, sad):
Install it into the local Maven repository:
mvn install:install-file -Dfile=sw/jargs-1.0.0.jar -DgroupId=jargs -DartifactId=jargs -Dversion=1.0.0 -Dpackaging=jar