maven-plugins/simian/xdocs/installation.xml
2003-07-10 07:37:00 +00:00

41 lines
1.3 KiB
XML

<?xml version="1.0"?>
<document>
<properties>
<title>Simian Plugin Installation</title>
<author email="aslak@thoughtworks.net">Aslak Hellesoy</author>
</properties>
<body>
<section name="Simian Plugin Installation">
<p>
As long as this plugin is not a standard Maven plugin, it must
be installed manually. This is very easy.
</p>
<p>
If you have a binary distribution of the plugin, just copy the plugin jar file
to your <code>$MAVEN_HOME/plugins</code> directory. and the simian
jar file to <code>$MAVEN_HOME/repository/simian/jars</code>.
</p>
<p>
If you have a source distribution of the plugin, installing the plugin is just as easy.
Just run
</p>
<source>maven plugin:install</source>
<p>
from the root directory of the unpacked distribution.
</p>
<p>
To enable the plugin add the following to your project.xml's
/project/reports node:
</p>
<source>&lt;report&gt;maven-simian-plugin&lt;/report&gt;</source>
<p>
For further details about how to use the plugin, see the
<a href="goals.html">Goals</a> and <a href="properties.html">Properties</a>
pages.
</p>
</section>
</body>
</document>