Merge branch 'master' of https://scm.cri.ensmp.fr/git/Faustine
[Faustine.git] / INSTALL.txt
1 Installing Faustine on a Unix machine
2 =====================================
3
4
5 PREREQUISITES
6 -------------
7
8 * OCaml is needed (tested version: 4.00.1).
9 * The GNU C compiler gcc is recommended.
10
11
12 INSTALLATION INSTRUCTIONS
13 -------------------------
14
15 0- Faustine's git repository can be cloned calling:
16
17 git clone https://scm.cri.ensmp.fr/git/Faustine.git
18
19 1- Configure the system. From the top directory, do:
20
21 ./configure
22
23 2- From the top directory, do:
24
25 make
26
27 This builds Faustine interpreter (and an adhoc Faust multirate preprocessor).
28 This phase is fairly verbose; consider redirecting the output to a file:
29
30 make > makelog.txt
31
32 3- From the top directory, do:
33
34 make install
35
36 This installs Faustine interpreter and libraries (by default in /usr/local/bin and /usr/local/lib).
37
38 4- (Optional) To be test things work well, you can try to
39 test -- that is, to process a sine wave with
40 the newly created interpreter. From the top directory, do:
41
42 make test
43
44
45
46 -- Karim Barkati and Haisheng Wang, 2013