README.txt

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