X-Git-Url: https://scm.cri.ensmp.fr/git/Faustine.git/blobdiff_plain/fc2ec49c325b99370170789886b4be4f43e16d68..b8e89a384896a4f8ce3e1990a10c88e7164af55c:/README.txt

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..b0ff5d1
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,71 @@
+OVERVIEW
+========
+
+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
+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
+--------
+
+  Changes.txt           what's new with each release
+  INSTALL               instructions for installation
+  LICENSE               license and copyright notice
+  Makefile              main Makefile generated by configure
+  Makefile.in           main Makefile body
+  README                this file
+  configure             configuration script
+  examples/             vector examples (fft, image processing...)
+  interpretor/          Faustine's interpretor source code
+  libs/                 external libraries
+
+
+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, 2013