Initial import.
[Faustine.git] / README
1 OVERVIEW
2 ========
3
4 MRFausti is an interpreter for multi-rate FAUST programs, written in OCaml.
5
6 FAUST (Functional Audio Stream) is a functional programming language
7 specifically designed for real-time signal processing and
8 synthesis. It targets high-performance signal processing applications
9 and audio plug-ins for a variety of platforms and
10 standards. <http://faust.grame.fr>
11
12 MRFausti provides support for some vector features presented in the
13 paper "Semantics for Multirate Faust", written by Pierre Jouvelot and
14 Yann Orlarey, 2009:
15
16 - vectorize
17 - serialize
18 - [] (pick an element from a vector)
19 - # (concatenate two vectors)
20
21
22
23 CONTENTS
24 --------
25
26 Changes what's new with each release
27 INSTALL instructions for installation
28 LICENSE license and copyright notice
29 Makefile main Makefile
30 README this file
31 config/ autoconfiguration stuff
32 emacs/ OCaml editing mode and debugger interface for GNU Emacs
33 lex/ lexer generator
34 otherlibs/ several external libraries
35 parsing/ syntax analysis
36 stdlib/ standard library
37 tools/ various utilities
38 toplevel/ interactive system
39 typing/ typechecking
40 utils/ utility libraries
41 yacc/ parser generator
42
43
44 INSTALLATION
45 ------------
46
47 See the file INSTALL for installation instructions on Unix, Linux and
48 MacOS X machines. For MS Windows, see README.win32.
49
50
51 UPDATE
52 ------
53
54
55
56 DOCUMENTATION
57 -------------
58
59 The FAUST documentation is available at
60
61 http://faust.grame.fr
62
63 The OCaml manual is distributed in HTML, PDF, Postscript, DVI, and
64 Emacs Info files. It is available on the World Wide Web, at
65
66 http://caml.inria.fr/