README

   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               what's new with each release
  28   INSTALL               instructions for installation
  29   LICENSE               license and copyright notice
  30   Makefile              main Makefile
  31   README                this file
  32   config/               autoconfiguration stuff
  33   emacs/                OCaml editing mode and debugger interface for GNU Emacs
  34   lex/                  lexer generator
  35   otherlibs/            several external libraries
  36   parsing/              syntax analysis
  37   stdlib/               standard library
  38   tools/                various utilities
  39   toplevel/             interactive system
  40   typing/               typechecking
  41   utils/                utility libraries
  42   yacc/                 parser generator
  43
  44
  45 INSTALLATION
  46 ------------
  47
  48 See the file INSTALL.
  49
  50
  51 UPDATE
  52 ------
  53
  54 Faustine's git repository can be cloned with correct rights:
  55 git clone https://scm.cri.ensmp.fr/git/Faustine.git
  56
  57
  58 DOCUMENTATION
  59 -------------
  60
  61 * No specific documentation is provided for Faustine by now.
  62 Faustine's options can be seen calling "faustine --help".
  63 You can read "Semantics for Multirate Faust", Pierre Jouvelot and
  64 Yann Orlarey, 2009.
  65
  66 * The FAUST documentation is available at
  67
  68         http://faust.grame.fr
  69
  70 * The OCaml manual is distributed in HTML, PDF, Postscript, DVI, and
  71 Emacs Info files.  It is available on the World Wide Web, at
  72
  73         http://caml.inria.fr/
  74
  75
  76
  77 -- Karim Barkati and Haisheng Wang, 2013