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

[rd...@apache.org]

Author: rdonkin
Date: Wed Nov  7 21:00:46 2012
New Revision: 1406802

URL: http://svn.apache.org/viewvc?rev=1406802&view=rev
Log:
RAT-123 improve documentation for core module

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=1406802&r1=1406801&r2=1406802&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 Wed Nov  7 21:00:46 2012
@@ -45,3 +45,28 @@ Developing Rat
  A Maven plugin | {{{http://maven.apache.org}Apache Maven}}     | {{{../apache-rat-plugin}apache-rat-plugin}}       |
 *----------+--------------+----------------+
 <<Modules that run Rat>>
+
+ Support for new build tools and alternative ways to run rat should be coded
+ in new modules building on <<<apache-rat-core>>>. Developers interested in
+ improving existing support for a specific build tool should start by taking
+ a look at that module.
+
+* Diving into Core
+
+ Browse the source {{{./xref/index.html}here}}.
+
+ Read the JavaDocs {{{./apidocs/index.html}here}}.
+
+ Check out with {{{http://subversion.apache.org}Subversion}}
+
++------------------------------------------+
+svn co http://svn.apache.org/repos/asf/creadur/rat/trunk/
++------------------------------------------+
+
+ Build with {{{http://maven.apache.org/} Apache Maven}}
+
++------------------------------------------+
+mvn install
++------------------------------------------+
+
+ Subscribe to our {{{./mail-lists.html}mailing lists}} for a warm welcome one and all.
\ No newline at end of file