X-Git-Url: https://scm.cri.mines-paristech.fr/git/Faustine.git/blobdiff_plain/06159b51a934937f647ec7119b47cb466d8e50b1..5bb5b9bdc903f9380475801365740439f59fd7cb:/README?ds=sidebyside diff --git a/README b/README index b4955fc..42a0b56 100644 --- a/README +++ b/README @@ -1,7 +1,8 @@ OVERVIEW ======== -MRFausti is an interpreter for multi-rate FAUST programs, written in OCaml. +Faustine is an interpreter for multi-rate FAUST programs, written in OCaml, +at CRI of MINES ParisTech. FAUST (Functional Audio Stream) is a functional programming language specifically designed for real-time signal processing and @@ -9,13 +10,13 @@ synthesis. It targets high-performance signal processing applications and audio plug-ins for a variety of platforms and standards. -MRFausti provides support for some vector features presented in the +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) +- [ ] (pick an element from a vector) - # (concatenate two vectors) @@ -44,23 +45,33 @@ CONTENTS INSTALLATION ------------ -See the file INSTALL for installation instructions on Unix, Linux and -MacOS X machines. For MS Windows, see README.win32. +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 ------------- -The FAUST documentation is available at +* 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 +* 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, 2013 \ No newline at end of file