Download required files

In order to run jGrouseDoc you would need to download and install:

• Latest jGrouseDoc distribution
• JRE 5 or newer
• ANT 1.7 or newer, or download a version of jGrouseDoc bundled with ANT (since version 2.0)

Install downloaded files

jGrouseDoc and ANT are shipped as platform-neutral archives. Once they downloaded, simply unpack the archives to your file system. The directory with jGrouseDoc installation would be referred in this document as jGrouseDocHome directory and the directory with ANT would be referred as ANT_HOME. Note - it could be quite convenient, although not mandatory, to add ANT_HOME/bin to your system's PATH.

For installation of JRE follow the instructions supplied by along with the package.

Building from source files

You can either use the archived source distribution, available at http://code.google.com/p/jgrousedoc/downloads/list or download the whole project from SVN (http://code.google.com/p/jgrousedoc/source/checkout). To build the source, simply run ANT from the project directory. The build process would create a binary distribution file (like jGrouseDoc-2.0.zip).

Configuration

Copy build.xml and jgrousedoc.properties files from jGrouseDocHome into the directory with your project. The content of build.xml file is release-specific and most users do not need to modify it. If you were building from the source files, make sure that you are getting build.xml and jgrousedoc.properties from the generated distribution.

In jgrousedoc.properties file it is necessary to modify the following properties:

• jGrouseHome.default - specifies the location of jGrouse distribution (jGrouseDocHome). Note: it is recommended to use forward slashes, regardless whether you are running on Unix or on Windows.
• inputDir.default - specifies the directory containing JavaScript source files
• outputDir - specifies the directory with generated files. This directory is re-created with every run of jGrouseDoc, so it should not be the same as the source directory.
• skin - specifies the "skin" for rendered documentation. Skin is an alternate method of rendering documentation
• theme - specifies the "theme" for rendered documentation. Theme is an alternate set of stylesheets and related resources, which could be applied to certain skins

Other configuration options are described in Advanced Configuration section.

Upgrading jGrouseDoc

We are doing our best to ensure backward compatibility between jGrouseDoc versions. When upgrading to a new version of jGrouseDoc, unpack the new version into the directory with old version and copy the supplied build.xml to the directory with your project.