svn commit: r692225 - /incubator/rat/main/trunk/rat/src/site/apt/index.apt

[rd...@apache.org]

Author: rdonkin
Date: Thu Sep  4 13:23:54 2008
New Revision: 692225

URL: http://svn.apache.org/viewvc?rev=692225&view=rev
Log:
Corrections to the website

Modified:
    incubator/rat/main/trunk/rat/src/site/apt/index.apt

Modified: incubator/rat/main/trunk/rat/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/rat/main/trunk/rat/src/site/apt/index.apt?rev=692225&r1=692224&r2=692225&view=diff
==============================================================================
--- incubator/rat/main/trunk/rat/src/site/apt/index.apt (original)
+++ incubator/rat/main/trunk/rat/src/site/apt/index.apt Thu Sep  4 13:23:54 2008
@@ -37,24 +37,31 @@
  RAT is intended to be self documenting: reports should include introductory material
  describing their function. Building RAT describes how to run RAT. Running RAT 
  describes the options available. The release notes describe the current state of
- RAT.
-
-Building RAT
-
- Building RAT requires that you have either 
- {{{http://ant.apache.org/} Apache Ant}} or
- {{{http://maven.apache.org/} Apache Maven}} installed.
- You can then use a command such as:
-
-+------------------------------------------+
-ant build
-+------------------------------------------+
-
- or
-
+ RAT.
+
+Checking Out RAT
+
+ RAT contains a number of different products. 
+ 
+ To checkout the main application run
+
++------------------------------------------+
+svn co http://svn.apache.org/repos/asf/incubator/rat/main/trunk/rat/
++------------------------------------------+
+
+Building RAT
+
+ Building RAT requires
+ {{{http://maven.apache.org/} Apache Maven}}. 
+ Read BUILD.txt or (for the impatient) do
+ 
 +------------------------------------------+
-mvn install
+mvn install package
 +------------------------------------------+
+
+ This should build all modules. The application jar will be 
+ rat-app/target/rat-app-X.Y-SNAPSHOT.jar where X and Y are the current
+ major and minor version numbers.
 
 Running RAT
 
@@ -63,7 +70,7 @@
  Run from the command line with:
 
 +------------------------------------------+
-java -jar rat-VERSION.jar --help
+java -jar rat-app-VERSION.jar --help
 +------------------------------------------+
 
  Where VERSION is replaced with the version number you are