annotate README @ 0:add35537fdbb tip

Initial import
author irh <ian.r.hobson@gmail.com>
date Thu, 25 Aug 2011 11:05:55 +0100
parents
children
rev   line source
ian@0 1 --------------------------------------------------------------------------------
ian@0 2 GPSynth (c) 2011 Ian Hobson - ian.r.hobson@gmail.com
ian@0 3 --------------------------------------------------------------------------------
ian@0 4
ian@0 5 GPSynth is a program that uses genetic programming techniques to artificially
ian@0 6 evolve SuperCollider synthesizers towards the ability to emulate a target sound
ian@0 7 file.
ian@0 8
ian@0 9 GPSynth is open source software, released under a GPL license.
ian@0 10 See the COPYING file for information on how this software can be used.
ian@0 11
ian@0 12
ian@0 13 --------------------------------------------------------------------------------
ian@0 14 Requirements
ian@0 15 --------------------------------------------------------------------------------
ian@0 16
ian@0 17 GPSynth has been tested on OS X 10.6.8. It should compile on Linux but has not
ian@0 18 been tested yet. Support for Linux will be added soon.
ian@0 19
ian@0 20 GPSynth requires SuperCollider to be installed on your system. If you don't have
ian@0 21 SuperCollider in /Applications/SuperCollider then you need to specify the path
ian@0 22 to its location with the --scpath option.
ian@0 23
ian@0 24
ian@0 25 --------------------------------------------------------------------------------
ian@0 26 Usage
ian@0 27 --------------------------------------------------------------------------------
ian@0 28
ian@0 29 In its most simple form, gpsynth takes a single argument, --target:
ian@0 30
ian@0 31 gpsynth --target test.wav
ian@0 32
ian@0 33 GPSynth uses Libsndfile to load audio file data, for a list of supported formats
ian@0 34 see http://www.mega-nerd.com/libsndfile.
ian@0 35
ian@0 36 A timestamped folder will be created in the current path, use the --workfolder
ian@0 37 option to change where the folder will be created.
ian@0 38
ian@0 39 See gpsynth --help for a full list of options.
ian@0 40
ian@0 41
ian@0 42 --------------------------------------------------------------------------------
ian@0 43 Build instructions
ian@0 44 --------------------------------------------------------------------------------
ian@0 45
ian@0 46 Building GPSynth has been tested on Mac OS X 10.6.8 with LLVM 3.0 and GCC 4.2.
ian@0 47
ian@0 48 You need the following libraries installed on your system to build GPSynth.
ian@0 49 Boost (at least v1.44, tested against v1.47) with libraries compiled with
ian@0 50 multi-threading enabled.
ian@0 51 LibSndFile
ian@0 52 FFTW
ian@0 53
ian@0 54 If these libraries are not on your system, an easy way to get them is with
ian@0 55 Homebrew (http://mxcl.github.com/homebrew/). After installing homebrew the
ian@0 56 following commands should get your system ready to compile GPSynth:
ian@0 57
ian@0 58 brew install boost
ian@0 59 brew install libsndfile
ian@0 60 brew install fftw
ian@0 61
ian@0 62 An XCode 4 project is included with GPSynth for convenience, however the best
ian@0 63 way to install GPSynth is by using the CMake build scripts. If you don't have
ian@0 64 CMake on your system then it can be installed with Homebrew:
ian@0 65 brew install cmake
ian@0 66
ian@0 67 cd in to the root of the gpsynth source directory (where this README file is),
ian@0 68 then perform the following commands:
ian@0 69 mkdir build
ian@0 70 cd build
ian@0 71 cmake ..
ian@0 72 sudo make install
ian@0 73
ian@0 74
ian@0 75