INSTALL.txt review.
[Faustine.git] / README.txt
1 OVERVIEW
2 ========
3
4 Faustine is an interpreter for multi-rate FAUST programs, written in OCaml,
5 at CRI of MINES ParisTech, and covered by the GNU Public License V3 (see
6 LICENSE.txt).
7
8 FAUST (Functional Audio Stream) is a functional programming language
9 specifically designed for real-time signal processing and
10 synthesis. It targets high-performance signal processing applications
11 and audio plug-ins for a variety of platforms and
12 standards. <http://faust.grame.fr>
13
14 Faustine provides support for some vector features presented in the
15 paper "Semantics for Multirate Faust", written by Pierre Jouvelot and
16 Yann Orlarey, 2009:
17
18 - vectorize
19 - serialize
20 - [ ] (pick an element from a vector)
21 - # (concatenate two vectors)
22
23
24
25 CONTENTS
26 --------
27
28 architecture/ library files in Faustine (fft.lib, morpho.libÉ)
29 benchmarks/ benchmark result files
30 Changes.txt what's new with each release
31 configure compilation configuration script
32 examples/ vector examples (fft, image processingÉ)
33 INSTALL.txt Faustine installation instructions
34 interpreter/ Faustine's interpreter source code
35 LICENSE.txt license and copyright notice
36 Makefile main Makefile to compile and install
37 README.txt this file
38
39
40 INSTALLATION
41 ------------
42
43 See the file INSTALL.
44
45
46 UPDATE
47 ------
48
49 Faustine's git repository can be cloned (with correct rights):
50 git clone https://scm.cri.ensmp.fr/git/Faustine.git
51
52
53 DOCUMENTATION
54 -------------
55
56 * No specific documentation is provided for Faustine by now.
57 Faustine's options can be seen calling "faustine --help".
58 You can read "Semantics for Multirate Faust", Pierre Jouvelot and
59 Yann Orlarey, 2009.
60
61 * The FAUST documentation is available at
62
63 http://faust.grame.fr
64
65 * The OCaml manual is distributed in HTML, PDF, Postscript, DVI, and
66 Emacs Info files. It is available on the World Wide Web, at
67
68 http://caml.inria.fr/
69
70
71
72 -- Karim Barkati and Haisheng Wang, MINES ParisTech, 2013