Permalink
Browse files

make unzip requirement more obvious

  • Loading branch information...
1 parent bb2c9ce commit 0c6db3792a144830b643c17e6622d01bf2b07700 Robert Newson committed Jan 30, 2011
Showing with 9 additions and 4 deletions.
  1. +9 −4 README.md
View
@@ -20,21 +20,26 @@ Issue tracking at <a href="http://github.com/rnewson/couchdb-lucene/issues">gith
<h1>Minimum System Requirements</h1>
-Java 1.5 (or above) is required; the Sun version is recommended as it's regularly tested against.
+Java 1.5 (or above) is required; the <strike>Sun</strike> Oracle version is recommended as it's regularly tested against.
-<h1>Build couchdb-lucene</h1>
+<h1>Build and run couchdb-lucene</h1>
<ol>
<li>Install Maven 2.
<li>checkout repository
<li>type 'mvn'
-<li>configure couchdb (see below)
+<li>cd target
+<li>unzip couchdb-lucene-<version>.zip
+<li>cd couchdb-lucene-<version>
+<li>./bin/run
</ol>
-You will now have a zip file in the target/ directory. This contains all the couchdb-lucene code, dependencies, startup scripts and configuration files to run couchdb-lucene.
+The zip file contains all the couchdb-lucene code, dependencies, startup scripts and configuration files you need, so unzip it wherever you wish to install couchdb-lucene.
<h1>Configure CouchDB</h1>
+The following settings are needed in CouchDB's local.ini file in order for it to communicate with couchdb-lucene;
+
<pre>
[couchdb]
os_process_timeout=60000 ; increase the timeout from 5 seconds.

0 comments on commit 0c6db37

Please sign in to comment.