blob: d8969e3254e3b74899bb7ffa4a306bb0ca45e564 [file] [log] [blame]
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Building</title>
<author email="dev@commons.apache.org">Commons Documentation Team</author>
</properties>
<body>
<!-- ================================================== -->
<section name="Overview">
<p>
Commons Email uses <a href="http://maven.apache.org">Maven 2.0</a>
</p>
</section>
<!-- ================================================== -->
<section name="Maven Goals">
<p>
To build a jar file, change into Email's root directory and run "mvn package".
The result will be in the "target" subdirectory.
</p>
<p>
To build the Javadocs, run "mvn javadoc:javadoc".
The result will be in "target/docs/apidocs".
</p>
<p>
To build the full website, run "mvn site".
The result will be in "target/site".
You must be using JDK 5 or higher to successfully complete this target.
</p>
</section>
<!-- ================================================== -->
<section name="Development">
<p>
Commons Email may be used on any JRE from 1.5 onwards.
</p>
<p>
Commons Email requires <a href="http://code.google.com/p/subethasmtp/">SubEtha SMTP</a>
for its unit tests. <br />
</p>
<p>
This jar will be automatically installed to your local Maven 2 repository
if you build using Maven.
</p>
</section>
<!-- ================================================== -->
</body>
</document>