annotate INSTALL.txt @ 1301:26da0e253e68 project-file-rework

Don't -Werror here
author Chris Cannam
date Fri, 28 Oct 2016 11:32:22 +0100
parents dac686f8efb8
children 0d8ee478610b
rev   line source
Chris@350 1
Chris@350 2 To compile from source
Chris@350 3 ----------------------
Chris@350 4
Chris@392 5 To build on a Unix-like system, run
Chris@350 6
Chris@350 7 $ ./configure && make
Chris@350 8
Chris@350 9 The following additional libraries are required or optional when
Chris@350 10 building the SV core libraries:
Chris@350 11
Chris@859 12 REQUIRED Qt v5 http://qt-project.org/
Chris@350 13 REQUIRED Vamp Plugin SDK v2.x http://www.vamp-plugins.org/
Chris@350 14 REQUIRED Rubber Band Library http://www.breakfastquay.com/rubberband/
Chris@350 15 REQUIRED libsndfile http://www.mega-nerd.com/libsndfile/
Chris@350 16 REQUIRED libsamplerate http://www.mega-nerd.com/SRC/
Chris@350 17 REQUIRED FFTW3 http://www.fftw.org/
Chris@350 18 REQUIRED bzip2 library http://www.bzip.org/
Chris@856 19 REQUIRED Sord and Serd libraries http://drobilla.net/software/
Chris@350 20
Chris@350 21 Optional MAD mp3 decoder http://www.underbit.com/products/mad/
mathieu@441 22 Optional Oggz and fishsound http://xiph.org/oggz/
Chris@350 23 Optional liblo OSC library http://www.plugin.org.uk/liblo/
Chris@350 24
Chris@856 25 If you are going to build the rest of the SV libraries and the Sonic
Chris@856 26 Visualiser application, you will also need one or more of:
Chris@350 27
Chris@350 28 Optional JACK http://www.jackaudio.org/
Chris@350 29 Optional PortAudio v19 http://www.portaudio.com/
Chris@350 30 Optional PulseAudio http://www.pulseaudio.org/
Chris@350 31
Chris@350 32 Although JACK, PortAudio, and PulseAudio are individually optional,
Chris@350 33 you will need to have one or the other of them in order to get any
Chris@350 34 audio playback. Usually JACK is preferred on Linux, with PulseAudio
Chris@350 35 as a backup, and PortAudio is used elsewhere.
Chris@350 36
Chris@350 37 On Linux, you will need the ALSA libraries (used for MIDI).
Chris@350 38
Chris@350 39 If you happen to be using a Debian-based Linux, you probably want to
Chris@859 40 apt-get install something like the following packages: qtbase5-dev
Chris@859 41 qt5-default libsndfile1-dev libsamplerate0-dev libfftw3-dev libbz2-dev
Chris@859 42 libjack-dev libjack0 libpulse-dev libmad0-dev libid3tag0-dev
Chris@859 43 liboggz2-dev libfishsound1-dev libasound2-dev liblo-dev liblrdf0-dev
Chris@859 44 libsord-dev libserd-dev vamp-plugin-sdk librubberband-dev.
Chris@350 45