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