| <?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 Chain uses <a href="http://maven.apache.org">Maven 2</a> or |
| <a href="http://ant.apache.org">Ant</a> as a build system. |
| </p> |
| <p> |
| Chain 2.0 requires a minimum of JDK 1.5 to build. |
| </p> |
| </section> |
| <section name="Maven 2 Goals"> |
| <p> |
| The following <strong><i>Maven 2</i></strong> commands can be used to build Chain: |
| </p> |
| <ul> |
| <li><code>mvn clean</code> - clean up</li> |
| <li><code>mvn test</code> - compile and run the unit tests</li> |
| <li><code>mvn site</code> - create the documentation</li> |
| <li><code>mvn package</code> - build the jar</li> |
| <li><code>mvn install</code> - build the jar and install in local maven repository</li> |
| <li><code>mvn site assembly:assembly</code> - Create the source and binary distributions</li> |
| </ul> |
| </section> |
| <!-- ================================================== --> |
| <section name="Ant Goals"> |
| <p> |
| The following <strong><i>Ant</i></strong> commands can be used to build Chain: |
| </p> |
| <ul> |
| <li><code>ant clean</code> - clean up</li> |
| <li><code>ant test</code> - compile and run the unit tests</li> |
| <li><code>ant javadoc</code> - create javadocs</li> |
| <li><code>ant jar</code> - build the jar</li> |
| <li><code>ant dist</code> - Create the source and binary distributions</li> |
| </ul> |
| </section> |
| <!-- ================================================== --> |
| </body> |
| </document> |
