New version name (Version 1.0) for access from the FEEVER website.
[Faustine.git] / INSTALL.txt
1 Installing Faustine on a Unix machine
2 =====================================
3
4 VERSION : 1.0
5
6 =====================================
7
8
9 PREREQUISITES
10 -------------
11
12 * OCaml is needed (tested versions: 3.12.1, 4.00.1).
13 * Faust is needed (tested version: 0.9.24).
14 * The GNU C compiler gcc is recommended.
15 * Standard development utilities are required, such as `make' (install XCode command line tools on Mac OS).
16
17
18 INSTALLATION INSTRUCTIONS
19 -------------------------
20
21 0- Faustine's git repository can be cloned calling:
22
23 git clone https://scm.cri.ensmp.fr/git/Faustine.git
24
25 1- Configure the system. From within the Faustine directory, do:
26
27 ./configure
28
29 2- From within the Faustine directory, do:
30
31 make
32
33 This builds Faustine interpreter (and an adhoc Faust multirate preprocessor).
34 This phase is fairly verbose; consider redirecting the output to a file:
35
36 make > makelog.txt
37
38 3- From within the Faustine directory, do:
39
40 sudo make install
41
42 This installs Faustine interpreter and libraries (by default in /usr/local/bin and /usr/local/lib).
43
44 4- (Optional) To be test things work well, you can try to
45 test -- that is, to process a sine wave with
46 the newly created interpreter. From the Faustine directory, do:
47
48 make test
49
50
51
52 -- Karim Barkati and Haisheng Wang, MINES ParisTech, 2013