Fetching contributors…
Cannot retrieve contributors at this time
80 lines (53 sloc) 2.72 KB
<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=UTF-8" http-equiv="content-type">
<title>PIE Documentation: Building PIE From Source</title>
</head>
<body>
<h1>Building PIE From Source</h1>
<!-- noformat on -->
<p>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!</p>
<h2 id="prereqs">Prerequisites</h2>
<p>Building PIE is straightforward. You need to have the following tools installed:</p>
<ol>
<li><a href="http://git-scm.com/">Git</a>, if you are going to be checking out the source from the Git repository</li>
<li><a href="http://java.com">Java</a> runtime, version 6 or higher</li>
<li><a href="http://ant.apache.org">Ant</a>, for performing the build</li>
</ol>
<p>Once these prerequisites are installed, perform the following steps:</p>
<h2 id="getsource">Get the source code</h2>
<p>You have two options for getting the source:</p>
<ol>
<li>Check out the source using Git:
<pre><kbd>git clone git://github.com/lojjic/PIE.git
cd PIE</kbd></pre>
If you want the 2.x beta branch (master) then you're done; if you want the 1.x stable branch then run:
<pre><kbd>git checkout 1.x</kbd></pre>
or:
</li>
<li>Download an archive of the source:<br>
<a href="http://github.com/lojjic/PIE/archives/master">http://github.com/lojjic/PIE/archives/master</a> (2.x beta branch)<br>
<a href="http://github.com/lojjic/PIE/archives/1.x">http://github.com/lojjic/PIE/archives/1.x</a> (1.x stable branch)
</li>
</ol>
<h2 id="build">Perform the build</h2>
<p>From the root directory of your local copy of the source code, invoke the following command in the terminal:</p>
<pre><kbd>ant</kbd></pre>
<p>This will perform the build, creating a new directory named "build/". This directory will contain the following
files:</p>
<ul>
<li>PIE.htc</li>
<li>PIE_IE678.js</li>
<li>PIE_IE9.js</li>
<li>PIE_uncompressed.htc</li>
<li>PIE_IE678_uncompressed.js</li>
<li>PIE_IE9_uncompressed.js</li>
</ul>
<p>To use these files, copy them together into a directory on your server, and reference PIE.htc (or
PIE_uncompressed.htc for debugging) in a behavior property in your CSS. Or, if you want to use the
PIE JS version then you can include the PIE_IEx.js files using script tags (see the
<a href="/documentation/pie-js/">PIE JS</a> documentation for details.)</p>
<!-- noformat off -->
</body>
</html>