svn commit: r1488800 - /maven/sandbox/trunk/dist-tools/dist-tool-plugin/src/site/markdown/index.md

[hb...@apache.org]

Author: hboutemy
Date: Sun Jun  2 22:24:27 2013
New Revision: 1488800

URL: http://svn.apache.org/r1488800
Log:
added an introduction

Added:
    maven/sandbox/trunk/dist-tools/dist-tool-plugin/src/site/markdown/index.md

Added: maven/sandbox/trunk/dist-tools/dist-tool-plugin/src/site/markdown/index.md
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/dist-tools/dist-tool-plugin/src/site/markdown/index.md?rev=1488800&view=auto
==============================================================================
--- maven/sandbox/trunk/dist-tools/dist-tool-plugin/src/site/markdown/index.md (added)
+++ maven/sandbox/trunk/dist-tools/dist-tool-plugin/src/site/markdown/index.md Sun Jun  2 22:24:27 2013
@@ -0,0 +1,19 @@
+About dist-tool-plugin
+=====
+
+The dist-tool-plugin checks that Maven release rules are well applied across every artifact.
+
+Results are displayed in 2 reports:
+
+* [Disttool> Sites][1] report, for checks about sites associated to artifacts,
+
+* [Disttool> Source Release][2] report, for checks about artifacts source release publication.
+
+This is [Work In Progress][3]...
+
+Notice that this plugin is actually intended for Maven itself only: if interest is expressed to use it
+in other context, it would require more configurations.
+
+[1]: ./dist-tool-checksite.html
+[2]: ./dist-tool-checksourcerelease.html
+[3]: ./todo.html
\ No newline at end of file