tomwalters@270: #summary Building AIM-C
tomwalters@270: #labels Phase-Design
tomwalters@270: 
tomwalters@270: = Introduction =
tomwalters@270: 
tomwalters@270: AIM-C is built using the [http://www.scons.org/ SCons] build system. SCons is multiplatform, and is based on Python. 
tomwalters@270: 
tomwalters@270: = Build Environment =
tomwalters@403: One of the major requirements of AIM-C is that it is written, as far as possible, in standard C++ (including some heavy dependence on the standard template library). This means that (in theory at least) it will compile under any reasonably sane C++ compiler. In practice, so far development has taken place mainly using GCC on Mac OS 10.6.
tomwalters@270: 
tomwalters@270: = External Dependencies =
tomwalters@403: Current dependencies are [http://www.mega-nerd.com/libsndfile/ libsndfile] and [http://cairographics.org cairo] for audio input and graphics output respectively. [http://www.portaudio.com/ PortAudio] is a requirement for live audio input. This will be ported over soon. The boost c++ extensions are also required for the module that adds noise to the input.
tomwalters@270: 
tomwalters@403: On Ubuntu, the necessary build tools and dependencies can be installed using the following command.
tomwalters@270: 
tomwalters@403: {{{
tomwalters@403: sudo apt-get install libsndfile-dev cairo-dev 
tomwalters@403: }}}
tomwalters@270: 
tomwalters@403: The project also uses [http://code.jellycan.com/simpleini/ simpleini] version 4.12 for storing, parsing and writing out parameters files, but this file (and the UTF support code that it requires) is included in the source repository. 
tomwalters@270: 
tomwalters@270: = Build Tools =
tomwalters@270: == Building ==
tomwalters@270: 
tomwalters@270: Assuming SCons is installed,  to build the source tree simply navigate to the top level of the source tree (where the SConstruct file resides) and issue the command:
tomwalters@270: 
tomwalters@270: `scons`
tomwalters@270: 
tomwalters@270: == Getting SCons ==
tomwalters@270: On GNU/Linux systems, either use your favourite package manager to install scons, for example on Debian / Ubuntu:
tomwalters@270: 
tomwalters@270: `sudo apt-get install scons`
tomwalters@270: 
tomwalters@270: On Mac OS X, I'd recommend using MacPorts. It's a handy way of installing all sorts of free software. First install MacPorts, then run the command:
tomwalters@270: 
tomwalters@270: `sudo port install scons`
tomwalters@270: 
tomwalters@270: Alternatively, in either case, you can just download and install a tarball from the [http://www.scons.org/ SCons site].
tomwalters@270: 
tomwalters@325: On Windows
tomwalters@325: See BuildingOnWindows