Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 76 lines (50 sloc) 2.84 kb
c97a6f2 Add documentation for performing build
Jason Johnston authored
1 <!DOCTYPE html>
2 <html>
3 <head>
4
5 <meta content="text/html; charset=UTF-8" http-equiv="content-type">
ee110db Documentation updates to sync with site and recent changes
Jason Johnston authored
6 <title>PIE Documentation: Building PIE From Source</title>
c97a6f2 Add documentation for performing build
Jason Johnston authored
7
8 </head>
9 <body>
10
ee110db Documentation updates to sync with site and recent changes
Jason Johnston authored
11 <h1>Building PIE From Source</h1>
c97a6f2 Add documentation for performing build
Jason Johnston authored
12
13
ee110db Documentation updates to sync with site and recent changes
Jason Johnston authored
14
15 <!-- noformat on -->
16
17 <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>
18
19 <h2 id="prereqs">Prerequisites</h2>
20
21 <p>Building PIE is straightforward. You need to have the following tools installed:</p>
c97a6f2 Add documentation for performing build
Jason Johnston authored
22
23 <ol>
24 <li><a href="http://git-scm.com/">Git</a>, if you are going to be checking out the source from the Git repository</li>
25 <li><a href="http://java.com">Java</a> runtime, version 6 or higher</li>
26 <li><a href="http://ant.apache.org">Ant</a>, for performing the build</li>
27 </ol>
28
29 <p>Once these prerequisites are installed, perform the following steps:</p>
30
31
32
ee110db Documentation updates to sync with site and recent changes
Jason Johnston authored
33 <h2 id="getsource">Get the source code</h2>
c97a6f2 Add documentation for performing build
Jason Johnston authored
34
35 <p>You have two options for getting the source:</p>
36
37 <ol>
38 <li>Check out the source using Git:
0b22935 @lojjic Update build doc with info about the 1.x branch
authored
39 <pre><kbd>git clone git://github.com/lojjic/PIE.git
40 cd PIE</kbd></pre>
41 If you want the 2.x unstable branch then you're done; if you want the 1.x stable branch then run:
42 <pre><kbd>git checkout 1.x</kbd></pre>
c97a6f2 Add documentation for performing build
Jason Johnston authored
43 or:
44 </li>
0b22935 @lojjic Update build doc with info about the 1.x branch
authored
45 <li>Download an archive of the source:<br>
46 <a href="http://github.com/lojjic/PIE/archives/master">http://github.com/lojjic/PIE/archives/master</a> (2.x unstable branch)<br>
47 <a href="http://github.com/lojjic/PIE/archives/1.x">http://github.com/lojjic/PIE/archives/1.x</a> (1.x stable branch)
c97a6f2 Add documentation for performing build
Jason Johnston authored
48 </li>
49 </ol>
50
51
52
ee110db Documentation updates to sync with site and recent changes
Jason Johnston authored
53 <h2 id="build">Perform the build</h2>
c97a6f2 Add documentation for performing build
Jason Johnston authored
54
55 <p>From the root directory of your local copy of the source code, invoke the following command in the terminal:</p>
56
57 <pre><kbd>ant</kbd></pre>
58
59 <p>This will perform the build, creating a new directory named "build/". This directory will contain the following
60 artifacts:</p>
61
62 <ul>
63 <li>PIE.htc - The fully compressed behavior file; this is the version which should be deployed in production
64 environments.</li>
65 <li>PIE_uncompressed.htc - An uncompressed version of the behavior; this is useful for debugging purposes but is
66 very large so it should not be deployed in production environments.</li>
fbbd13e Documentation updates
Jason Johnston authored
67 <li>PIE.js - The compressed version of the alternate <a href="/documentation/pie-js/">JavaScript edition</a> of
68 PIE. PIE.htc is the recommended file for most users.</li>
69 <li>PIE_uncompressed.js - The uncompressed version of the JavaScript edition.</li>
c97a6f2 Add documentation for performing build
Jason Johnston authored
70 </ul>
71
ee110db Documentation updates to sync with site and recent changes
Jason Johnston authored
72 <!-- noformat off -->
c97a6f2 Add documentation for performing build
Jason Johnston authored
73
74
75 </body>
76 </html>
Something went wrong with that request. Please try again.