README.adoc

   1 ZynAddSubFX
   2 -----------
   3 It is a feature heavy realtime software synthesizer for Linux, OSX,
   4 and Windows.
   5
   6 Originally written by Nasca Octavian Paul <zynaddsubfx AT yahoo D0T com>
   7
   8 Maintained by Mark McCurry 2009+.
   9
  10 ZynAddSubFX is free program and is distributed WITH NO WARRANTY.
  11 It is licensed under GNU General Public License version 2+.
  12
  13 The project page is
  14 http://sourceforge.net/projects/zynaddsubfx
  15 or
  16 http://zynaddsubfx.sourceforge.net
  17
  18 Mailing List:
  19 http://lists.sourceforge.net/mailman/listinfo/zynaddsubfx-user
  20
  21 Public Forum:
  22 http://www.kvraudio.com/forum/viewforum.php?f=47
  23
  24 Requirements:
  25 ~~~~~~~~~~~~~
  26 - FFTW 3.x.x  - necessary for Fast Fourier computations
  27 - MXML-2.5+ from www.minixml.org
  28 - zlib library from http://www.zlib.org
  29 - Jack Audio (may be optional in the future)
  30
  31 Optional:
  32 ~~~~~~~~~
  33 - FLTK 1.x.x (tested with fltk 1.3+)
  34 - a VST host for the VST version [For more information see:
  35   http://www.kvraudio.com/forum/viewtopic.php?t=268277&sid=95be0b6c9909300d566006428bcbb97d]
  36
  37 Compilation:
  38 ~~~~~~~~~~~~
  39   For the main program see doc/build.txt.
  40   To compile the Spliter, run "make" from the "Spliter" directory.
  41   To compile the Controller, run "make" from the "Controller" directory.
  42
  43 Running on Linux
  44 ~~~~~~~~~~~~~~~~
  45 Under linux there are several options for both audio output and MIDI input.
  46 Defaults are set at compile time and the desired backend can be set when
  47 starting ZynAddSubFX with the '-I' and '-O' options.
  48 The currently supported backends are:
  49
  50 - Audio Output
  51     * ALSA (Advanced Linux Sound Architecture)
  52     * OSS (Open Sound System)
  53     * JACK (JACK Audio Connection Kit)
  54     * Port Audio
  55
  56 - MIDI Input
  57     * ALSA
  58     * OSS
  59     * JACK
  60
  61 Running on OSX
  62 ~~~~~~~~~~~~~~
  63 Under OSX simply download the binary available on http://sourceforge.net/projects/zynaddsubfx
  64 and run with JACK
  65
  66 Running on Windows
  67 ~~~~~~~~~~~~~~~~~~
  68 NOTE: At this time only older versions of ZynAddSubFX were compiled on windows
  69       See older versions on sf.net (ie version 2.2.1)
  70
  71 Have fun! :-)
  72 --The ZynAddSubFX team