OVERVIEW
========

Faustine is an interpreter for multi-rate FAUST programs, written in OCaml,
at CRI of MINES ParisTech, and covered by the GNU Public License V3 (see
LICENSE.txt).

FAUST (Functional Audio Stream) is a functional programming language
specifically designed for real-time signal processing and
synthesis. It targets high-performance signal processing applications
and audio plug-ins for a variety of platforms and
standards. <http://faust.grame.fr>

Faustine provides support for some vector features presented in the
paper "Semantics for Multirate Faust", written by Pierre Jouvelot and
Yann Orlarey, 2009:

- vectorize 
- serialize
- [ ] (pick an element from a vector)
- # (concatenate two vectors)



CONTENTS
--------

  benchmarks/           benchmark result files
  Changes.txt           what's new with each release
  configure             compilation configuration script
  examples/             vector examples (fft, image processing...)
  INSTALL.txt           Faustine installation instructions
  interpreter/          Faustine's interpreter source code
  lib/                  library files in Faustine (fft.lib, morpho.lib...)
  LICENSE.txt           license and copyright notice
  Makefile              main Makefile to compile and install
  README.txt            this file


INSTALLATION
------------

See the file INSTALL.


UPDATE
------

Faustine's git repository can be cloned (with correct rights):
git clone https://scm.cri.ensmp.fr/git/Faustine.git


DOCUMENTATION
-------------

* No specific documentation is provided for Faustine by now.
Faustine's options can be seen calling "faustine --help".
You can read "Semantics for Multirate Faust", Pierre Jouvelot and
Yann Orlarey, 2009.

* The FAUST documentation is available at

        http://faust.grame.fr

* The OCaml manual is distributed in HTML, PDF, Postscript, DVI, and
Emacs Info files.  It is available on the World Wide Web, at

        http://caml.inria.fr/



-- Karim Barkati and Haisheng Wang, MINES ParisTech, 2013