blob: dbd1a0e3547eac5bbc86d401bbce7256b4e9cbc7 [file] [log] [blame]
<?xml version="1.0"?>
<!--
Copyright 2005-2006 The Apache Software Foundation.
Licensed 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 Commons SCXML</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties>
<body>
<!-- ================================================== -->
<section name="Overview">
<p>
Commons SCXML uses <a href="http://maven.apache.org">Maven</a> or
<a href="http://ant.apache.org">Ant</a> as a build system.
</p>
</section>
<!-- ================================================== -->
<section name="Maven Goals">
<p>
To build a jar file, change into SCXML's root directory and run "maven jar".
The result will be in the "target" subdirectory.
</p>
<p>
To build the Javadocs, run "maven javadoc".
The result will be in "target/docs/apidocs".
</p>
<p>
To build the full website, run "maven site". You will need to fetch the
<a href="http://svn.apache.org/repos/asf/jakarta/commons/proper/commons-build/trunk/">commons-build</a>
directory to build the full website, and place it as a sibling directory of
SCXML's root directory. The result will be in "target/docs".
</p>
</section>
<!-- ================================================== -->
<section name="Ant Goals">
<p>
To build a jar file, change into SCXML's root directory and run "ant jar".
The result will be in the "target" subdirectory.
</p>
<p>
To build the Javadocs, run "ant javadoc".
The result will be in "dist/docs".
</p>
</section>
<!-- ================================================== -->
</body>
</document>