PIE Documentation: Building PIE From Source

# Building PIE From Source

This document describes how you can build PIE from the most recent source code. This is useful if you want to get a feature or bug fix which hasn't yet made it into a release package. It's also necessary if you want to make changes to the code yourself to try and fix a bug or implement a new feature. If you do so, please consider contributing your changes back to the main project so we can all benefit!

## Prerequisites

Building PIE is straightforward. You need to have the following tools installed:

1. Git, if you are going to be checking out the source from the Git repository
2. Java runtime, version 6 or higher
3. Ant, for performing the build

Once these prerequisites are installed, perform the following steps:

## Get the source code

You have two options for getting the source:

1. Check out the source using Git:

       git clone git://github.com/lojjic/PIE.git

   or:
2. Download an archive of the source: http://github.com/lojjic/PIE/archives/master

## Perform the build

From the root directory of your local copy of the source code, invoke the following command in the terminal:

    ant

This will perform the build, creating a new directory named "build/". This directory will contain the following artifacts:

- PIE.htc - The fully compressed behavior file; this is the version which should be deployed in production environments.
- PIE_uncompressed.htc - An uncompressed version of the behavior; this is useful for debugging purposes but is very large so it should not be deployed in production environments.
- PIE.js - The compressed version of the alternate JavaScript edition of PIE. PIE.htc is the recommended file for most users.
- PIE_uncompressed.js - The uncompressed version of the JavaScript edition.