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   architecture/         library files in Faustine (fft.lib, morpho.libÉ)
  28   benchmarks/           benchmark result files
  29   Changes.txt           what's new with each release
  30   configure             compilation configuration script
  31   examples/             vector examples (fft, image processingÉ)
  32   INSTALL.txt           Faustine installation instructions
  33   interpreter/          Faustine's interpreter source code
  34   LICENSE.txt           license and copyright notice
  35   Makefile              main Makefile to compile and install
  36   README.txt            this file
  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