Difference between revisions of "TotalRecall Build Guide"

From Computational Memory Lab
Jump to: navigation, search
Line 35: Line 35:
 
<pre><nowiki>
 
<pre><nowiki>
 
sudo apt-get install ant
 
sudo apt-get install ant
 +
</nowiki></pre>
 +
 +
 +
* Install Git
 +
 +
<pre><nowiki>
 +
sudo apt-get install git-core
 
</nowiki></pre>
 
</nowiki></pre>
  
Line 55: Line 62:
  
 
<pre><nowiki>
 
<pre><nowiki>
ant install_native
 
 
cd Penn-TotalRecall
 
cd Penn-TotalRecall
 +
ant install_native
 
</nowiki></pre>
 
</nowiki></pre>
  

Revision as of 23:39, 12 April 2010


<<html(

Penn TotalRecall Build Guide

)>>

This document is for developers only. We provide easy installers for end-users.

Open-source software is a collaborative effort. Please inform us if anything on this page is incorrect or out of date.

The main development guide is located here.

<<TableOfContents(3)>>

Nightly builds

Nightly builds are performed around 5am and transferred to memory. sagan does the Mac and source distributions, rhino does the Linux distribution. We don't have an always-on Windows machines so the Windows builds are not nightly.

Building TotalRecall from source

Compiling TotalRecall for use on your own computer is designed to be very easy. The following instructions have been tested on recent versions of the operating systems described. To see which exact compilers and buildtool versions we used, see the build.xml file in the project.

Fair warning: these instructions are only for getting the program running on your computer, not for packaging things into nice standalone applications/installers. So they do involve moving our shared libraries into system paths (`/usr/lib`, `C:\Windows\System32`, and `C:\Windows\SysWow64`). Don't forget they're there if you edit the source code and want to try out your changes.

Ubuntu

  • Install JDK 6
sudo apt-get install sun-java6-jdk


  • Install Apache Ant
sudo apt-get install ant


  • Install Git
sudo apt-get install git-core


  • If on a 64-bit machine install 32-bit development headers
sudo apt-get install libc6-dev-i386


  • Download the project from the program homepage or get it straight out of the repository
git clone git://github.com/ymasory/Penn-TotalRecall.git


  • Change directory into the project root then compile + install the native libraries
cd Penn-TotalRecall
ant install_native


  • Compile the Java portion into a jar
ant package_jar


  • Run the program
java -jar dist/PennTotalRecall.jar


Mac OS X

  • Install XCode developer tools. These come on your OSX installation disc. You can also download them from Apple after registering.
  • Download the project from the program homepage or get it straight out of the repository
  • Change directory into the project root then compile + install the native libraries
ant install_native


  • Compile the Java portion into a jar
ant package_jar


  • Run the program
java -jar dist/PennTotalRecall.jar


Windows

The full build chain

Our build.xml does some fancy stuff like creating native executables and installers for the supported platforms. Read the documentation in build.xml to find out how. This native integration allows us (with the help of a few tricks) to avoid complex installers that tamper with users' shared libraries.