blob: cb6ce43438e650e4c8bc206bd72c9002ea7863a5 [file] [log] [blame]
<?xml version="1.0"?>
<document>
<header>
<title>Velocity Getting Started</title>
<subtitle>Velocity Getting Started</subtitle>
<authors>
<person name="Velocity Documentation Team" email="jvanzyl@locus.apache.org"/>
</authors>
</header>
<body>
<s1 title="Getting Started">
<p>
This document provides developers with simple documentation for getting
started with Velocity. For information about the overall structure of
Velocity, please refer to the <link href="design.html">Design</link> document.
</p>
<p>
Instructions for downloading and installing Velocity can be found on the
<link href="install.html">Install</link> document.
</p>
</s1>
<s1 title="View Detailed API Documentation">
<p>
If you are working on Unix/Linux and would like to create a full set
of detailed API documentation for Velocity, go to the <filename>build</filename> directory
and run the following script.
<source><![CDATA[
./build-velocity.sh javadocs
]]></source>
If you are working on Windows, running <code>build-velocity.bat javadocs</code> at the
DOS prompt will have the same effect.
</p>
</s1>
</body>
</document>