##### Quick Links

- Home
- Getting Started
- Download
- Overview
- FAQ
- Documentation

##### Developers

- Building Rio

##### Sub Projects

- Rio Installers
- Rio QA
- Rio Substrates
- Rio Utilities
- Classdepandjar

##### Project Documentation

- Project Information

## Build Procedures

### Building Rio

Rio is built using Ant. For information on Ant and to download the latest binary release of Ant see http://jakarta.apache.org/ant/index.html. The release has been built with Ant version 1.7

You will need the Java 2 JDK installed on your system, version 1.5.x (greater). The release has been built and tested with version 1.5.0_13. If you need to download the JDK, it can be downloaded from http://java.sun.com/javase/downloads/index.jsp.

If you have downloaded the "with-dependencies" distribution, simply change to the directory that you have downloaded Rio to, and run `ant` (note that this assumes you have ant in your path).

if you have not downloaded the "with-dependencies" distribution and want to build Rio, the easiest thing to do is to go download the "with-dependencies" distribution.

### Documentation Build Process

This section explains how the documentation for Rio is built. The build process uses two different skins: one for online documentation (in order to integrate well in java.net environment), and one for offline usage.

The online and offline documentations do not only differ by the skin used, but also some URLs. So, for example, when modifying the source of the `documentation.html` page, you should edit `documentation-orig.xml` and NOT `documentation.xml` which will be overriden by a previous run of the documentation build process.

#### Skins

Before you can build either the online or offline versions of the documentation, you need to build the skins.

In order to do so, you need to go in `src/site/maven-javanet-skin` and run `mvn install`. You should do the same in the directory `src/site/maven-tapestry-skin`.

#### Online documentation build process

Simply run `mvn site -DsiteEnvironment=online`.

#### Offline documentation build process

Simply run `mvn site -DsiteEnvironment=offline`.

#### Online & Offline documentation build process

If you run `ant site`, the two above steps will be done for you!

### Building the Rio Monitor OSX Application Bundle

The Rio Monitor UI can be launched as an executable JAR file (java -jar rio-ui.jar), or as an OSX Application Bundle (if running on OSX). To create the OSX Application Bundle all that you need to do is run the ant target ant rio-ui.app.

You will need to download the JarBundler ant task utility in order to use the ant tagret above. Currently the JarBundler utility is released under the GPL. In ordr to avoid conflcits, this utility is not included with the Rio download. You can get version 1.9 here http://informagen.com/JarBundler/

This will create the application bundle in the bin directory bin/Rio.app.

Then either double click on the application from Finder, or from the command line enter open bin/Rio Monitor.app