svn commit: r1405964 - /creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm

[rd...@apache.org]

Author: rdonkin
Date: Mon Nov  5 21:22:26 2012
New Revision: 1405964

URL: http://svn.apache.org/viewvc?rev=1405964&view=rev
Log:
RAT-123 starting to outline new documentation for core

Modified:
    creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm

Modified: creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm
URL: http://svn.apache.org/viewvc/creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm?rev=1405964&r1=1405963&r2=1405964&view=diff
==============================================================================
--- creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm (original)
+++ creadur/rat/trunk/apache-rat-core/src/site/apt/index.apt.vm Mon Nov  5 21:22:26 2012
@@ -19,39 +19,18 @@
                    Core Module
                    --------------------------
 
-Release Audit Tool (Rat)
+About Apache Rat
 
- Release Audit Tool (Rat) is a tool to improve accuracy and efficiency when checking
- releases. It is heuristic in nature: making guesses about possible problems. It
- will produce false positives and cannot find every possible issue with a release.
- It's reports require interpretation.
+ Rat audits software distributions, with a special interest in headers.
+ If this isn't quite what you're looking for then take a look at the
+ other products developed by {{{http://creadur.apache.org}Apache Creadur}},
+ including {{{http://creadur.apache.org/whisker}Apache Whisker}} which audits
+ and generates legal (for example <<<LICENSE>>>) documents for
+ complex software distributions.
 
-* Running from the Command Line
+Architecture
 
- Run from the command line with:
-
-+------------------------------------------+
-java -jar apache-rat-${project.version}.jar --help
-+------------------------------------------+
-
- This will output a help message detailing the command line
- options available to you.
-
-* Adding licence headers
-
- Rat can be used to automatically add licence headers to
- files that do not currently have them. Only files that
- are not excluded by the Rat configurations will be affected.
-
- To add licence headers use a command such as:
-
-+------------------------------------------+
-java -jar apache-rat-${project.version}.jar --addLicence
-  --copyright "Copyright 2008 Foo"
-  /path/to/project
-+------------------------------------------+
-
- This command will add the licence header directly to the
- source files. If you prefer to see which files will be
- changed and how then remove the "--force" option.
+* Modules
 
+ This module, <<<apache-rat-core>>>, is a library containing the basic
+ engine. Other modules allow this engine to be run in various ways.
\ No newline at end of file