README.adoc

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