README.txt

   1 OVERVIEW
   2 ========
   3
   4 VERSION : 1.0
   5
   6 ========
   7
   8 Faustine is an interpreter for multi-rate FAUST programs, written in OCaml,
   9 at CRI of MINES ParisTech, and covered by the GNU Public License V3 (see
  10 LICENSE.txt).
  11
  12 FAUST (Functional Audio Stream) is a functional programming language
  13 specifically designed for real-time signal processing and
  14 synthesis. It targets high-performance signal processing applications
  15 and audio plug-ins for a variety of platforms and
  16 standards. <http://faust.grame.fr>
  17
  18 Faustine provides support for some vector features presented in the
  19 paper "Semantics for Multirate Faust", written by Pierre Jouvelot and
  20 Yann Orlarey, 2009:
  21
  22 - vectorize
  23 - serialize
  24 - [ ] (pick an element from a vector)
  25 - # (concatenate two vectors)
  26
  27
  28
  29 CONTENTS
  30 --------
  31
  32   benchmarks/           benchmark result files
  33   Changes.txt           what's new with each release
  34   configure             compilation configuration script
  35   examples/             vector examples (fft, image processing...)
  36   INSTALL.txt           Faustine installation instructions
  37   interpreter/          Faustine's interpreter source code
  38   lib/                  library files in Faustine (fft.lib, morpho.lib...)
  39   LICENSE.txt           license and copyright notice
  40   Makefile              main Makefile to compile and install
  41   README.txt            this file
  42
  43
  44 INSTALLATION
  45 ------------
  46
  47 See the file INSTALL.
  48
  49
  50 UPDATE
  51 ------
  52
  53 Faustine's git repository can be cloned (with correct rights):
  54 git clone https://scm.cri.ensmp.fr/git/Faustine.git
  55
  56
  57 DOCUMENTATION
  58 -------------
  59
  60 * No specific documentation is provided for Faustine by now.
  61 Faustine's options can be seen calling "faustine --help".
  62 You can read "Semantics for Multirate Faust", Pierre Jouvelot and
  63 Yann Orlarey, 2009.
  64
  65 * The FAUST documentation is available at
  66
  67         http://faust.grame.fr
  68
  69 * The OCaml manual is distributed in HTML, PDF, Postscript, DVI, and
  70 Emacs Info files.  It is available on the World Wide Web, at
  71
  72         http://caml.inria.fr/
  73
  74
  75
  76 -- Karim Barkati and Haisheng Wang, MINES ParisTech, 2013