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