ian@0: --------------------------------------------------------------------------------
ian@0: GPSynth (c) 2011 Ian Hobson - ian.r.hobson@gmail.com
ian@0: --------------------------------------------------------------------------------
ian@0: 
ian@0: GPSynth is a program that uses genetic programming techniques to artificially 
ian@0: evolve SuperCollider synthesizers towards the ability to emulate a target sound 
ian@0: file.
ian@0: 
ian@0: GPSynth is open source software, released under a GPL license. 
ian@0: See the COPYING file for information on how this software can be used.
ian@0: 
ian@0: 
ian@0: --------------------------------------------------------------------------------
ian@0: Requirements
ian@0: --------------------------------------------------------------------------------
ian@0: 
ian@0: GPSynth has been tested on OS X 10.6.8. It should compile on Linux but has not
ian@0: been tested yet. Support for Linux will be added soon.
ian@0: 
ian@0: GPSynth requires SuperCollider to be installed on your system. If you don't have
ian@0: SuperCollider in /Applications/SuperCollider then you need to specify the path
ian@0: to its location with the --scpath option.
ian@0: 
ian@0: 
ian@0: --------------------------------------------------------------------------------
ian@0: Usage
ian@0: --------------------------------------------------------------------------------
ian@0: 
ian@0: In its most simple form, gpsynth takes a single argument, --target:
ian@0: 
ian@0: gpsynth --target test.wav
ian@0: 
ian@0: GPSynth uses Libsndfile to load audio file data, for a list of supported formats
ian@0: see http://www.mega-nerd.com/libsndfile.
ian@0: 
ian@0: A timestamped folder will be created in the current path, use the --workfolder
ian@0: option to change where the folder will be created. 
ian@0: 
ian@0: See gpsynth --help for a full list of options.
ian@0: 
ian@0: 
ian@0: --------------------------------------------------------------------------------
ian@0: Build instructions
ian@0: --------------------------------------------------------------------------------
ian@0: 
ian@0: Building GPSynth has been tested on Mac OS X 10.6.8 with LLVM 3.0 and GCC 4.2.
ian@0: 
ian@0: You need the following libraries installed on your system to build GPSynth.
ian@0: Boost (at least v1.44, tested against v1.47) with libraries compiled with 
ian@0: multi-threading enabled.
ian@0: LibSndFile
ian@0: FFTW
ian@0: 
ian@0: If these libraries are not on your system, an easy way to get them is with 
ian@0: Homebrew (http://mxcl.github.com/homebrew/). After installing homebrew the 
ian@0: following commands should get your system ready to compile GPSynth:
ian@0: 
ian@0: brew install boost
ian@0: brew install libsndfile
ian@0: brew install fftw
ian@0: 
ian@0: An XCode 4 project is included with GPSynth for convenience, however the best
ian@0: way to install GPSynth is by using the CMake build scripts. If you don't have 
ian@0: CMake on your system then it can be installed with Homebrew:
ian@0: brew install cmake
ian@0: 
ian@0: cd in to the root of the gpsynth source directory (where this README file is),
ian@0: then perform the following commands:
ian@0: mkdir build
ian@0: cd build
ian@0: cmake ..
ian@0: sudo make install
ian@0: 
ian@0: 
ian@0: