Difference between revisions of "TotalRecall Build Guide"

From Computational Memory Lab
Jump to: navigation, search
Line 109: Line 109:
  
 
== Windows ==
 
== Windows ==
* Install Git using the [http://code.google.com/p/msysgit/ msysgit] installer (skip if you don't plan to build version straight out of repository). During the installation be sure to select Run Git from the Windows Command Prompt.
+
* Install Git using the [http://code.google.com/p/msysgit/downloads/list msysgit] installer (skip if you don't plan to build version straight out of repository). During the installation be sure to select Run Git from the Windows Command Prompt.
 +
* Install [http://ant.apache.org/bindownload.cgi Apache Ant]. On Windows XP drag the unzipped folder to `C:\Program Files\`. On Windows Vista\7 64-bit drag to `C:\Program Files (x86)\'.
  
 
= The full build chain =
 
= 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.
 
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.

Revision as of 17:30, 27 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)>>

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 (skip if you don't plan to build version straight out of repository)
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 a nightly version of the project source from the program homepage or get it straight out of the repository
git clone git://github.com/ymasory/Penn-TotalRecall.git
cd Penn-TotalRecall
 


  • 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
 


Mac OS X

  • Install XCode developer tools. These come on your OSX installation disc. You can also download them from Apple after registering.
  • Install Git using this installer (skip if you don't plan to build version straight out of repository)
  • Download a nightly version of the project source from the program homepage or get it straight out of the repository
git clone git://github.com/ymasory/Penn-TotalRecall.git
cd Penn-TotalRecall
 


  • 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

  • Install Git using the msysgit installer (skip if you don't plan to build version straight out of repository). During the installation be sure to select Run Git from the Windows Command Prompt.
  • Install Apache Ant. On Windows XP drag the unzipped folder to `C:\Program Files\`. On Windows Vista\7 64-bit drag to `C:\Program Files (x86)\'.

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.