svn commit: r763639 - /jackrabbit/commons/jcr-rmi/trunk/README.txt

[ju...@apache.org]

Author: jukka
Date: Thu Apr  9 13:24:30 2009
New Revision: 763639

URL: http://svn.apache.org/viewvc?rev=763639&view=rev
Log:
rmi: Add build instructions to README

Modified:
    jackrabbit/commons/jcr-rmi/trunk/README.txt

Modified: jackrabbit/commons/jcr-rmi/trunk/README.txt
URL: http://svn.apache.org/viewvc/jackrabbit/commons/jcr-rmi/trunk/README.txt?rev=763639&r1=763638&r2=763639&view=diff
==============================================================================
--- jackrabbit/commons/jcr-rmi/trunk/README.txt (original)
+++ jackrabbit/commons/jcr-rmi/trunk/README.txt Thu Apr  9 13:24:30 2009
@@ -1,16 +1,31 @@
-==================================================================
-Welcome to JCR-RMI <http://jackrabbit.apache.org/commons/jcr-rmi/>
-==================================================================
+===================================================
+Apache Jackrabbit JCR-RMI
+<http://jackrabbit.apache.org/commons/jcr-rmi.html>
+===================================================
 
-This is the JCR-RMI component of the Apache Jackrabbit project.
-JCR-RMI is a part of the JCR Commons collection of generic JCR tools.
-
-JCR-RMI is a transparent Remote Method Invocation (RMI) layer for
-the Content Repository for Java Technology API (JCR) version 1.0.
+JCR-RMI is a transparent Remote Method Invocation (RMI) layer for JCR.
 The layer makes it possible to remotely access JCR content repositories
 and is compatible with all JCR implementations.
 
-Apache Jackrabbit is a project of the Apache Software Foundation.
+JCR-RMI is a part of the JCR Commons subproject of Apache Jackrabbit.
+Jackrabbit is a project of the Apache Software Foundation.
+
+Build instructions
+==================
+
+To build JCR-RMI, run the following command in this directory:
+
+    mvn clean install
+
+You need Java 1.4 (or higher) and Maven 2.0.9 (or higher) to do this.
+
+The build consists of two parts: the "jcr-rmi" module that contains the actual
+JCR-RMI component, and the "jcr-rmi-it" that contains an integration test
+suite for JCR-RMI. The integration tests are automatically run by Maven.
+
+After the build finishes successfully, you can find the compiled JCR-RMI
+component in ./jcr-rmi/target/. The component will also have been installed
+in your local Maven repository.
 
 License (see also LICENSE.txt)
 ==============================