Building from source

This project has not released any binaries yet. Until then, you can compile UFace yourself by following the instructions on this page.

Prerequisites

Before checking out and compiling the code, make sure you have the following software installed:

1. Java: Download and install JDK 1.5 or higher
2. Maven 2: Download and install Maven (2.0.9 or higher). Make sure that typing mvn -v produces output similar to the following:

Maven version: 2.0.9
Java version: 1.5.0_16
OS name: "mac os x" version: "10.5.5" arch: "i386" Family: "unix"

3. SVN: Download and install an svn client to be able to checkout the code.

Getting the source

You can checkout the source using your preferred svn client. The trunk folder contains 3 important subfolders:

1. proper: This folder contains the main development tree. Code in this folder always compiles and produces working output.
2. incubation: This folder contains the incubating development tree. Code in this folder should always compile but may not produce something that is working.
3. dormant: This folder contains code that was once active, but now dormant. It is very likely that the code in this folder doesn't even compile.

Building the proper tree

Navigate to trunk/proper/org.ufacekit and execute:

mvn clean install

Building the incubation tree

Navigate to trunk/incubation/org.ufacekit.incubation and execute:

mvn clean install

Please not that the incubation tree will only build if you've built the proper tree as well.

Importing the source in your favorite IDE

After you have build the proper tree (and optionally the incubation tree) you can import the code as projects inside your favorite IDE.

Eclipse

Make sure you have Eclipse installed, together with the PDE (Plug-in Development Environment). Currently we support Eclipse 3.4.1 or higher.

Navigate to trunk/proper/org.ufacekit and execute (after a fresh checkout):

mvn eclipse:eclipse

If you want to start with a clean environment, execute:

mvn eclipse:clean

Now you should be able to launch Eclipse and import existing projects underneath trunk/proper/org.ufacekit.

The same procedure applies to projects underneath trunk/incubation/org.ufacekit.incubation

IDEA

TODO