Merge branch 'newtree'
[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 external "libsndfile-ocaml" OCaml module is needed.
10 * The GNU C compiler gcc is recommended.
11
12
13 INSTALLATION INSTRUCTIONS
14 -------------------------
15
16 0- Faustine's git repository can be cloned calling:
17
18 git clone https://scm.cri.ensmp.fr/git/Faustine.git
19
20 1- Configure the system. From the top directory, do:
21
22 ./configure
23
24 This generates the configuration file "Makefile".
25 You will be asked for include paths:
26 * your OCaml path
27 * your libsndfile-ocaml path
28
29
30 2- From the top directory, do:
31
32 make
33
34 This builds Faustine interpreter (and an adhoc Faust multirate preprocessor)
35 for the first time.
36 This phase is fairly verbose; consider redirecting the output to a file:
37
38 make > makelog.txt
39
40
41 3- (Optional) To be test things work well, you can try to
42 test -- that is, to process a sine wave with
43 the newly created interpreter. From the top directory, do:
44
45 make test
46
47
48
49 -- Karim Barkati and Haisheng Wang, 2013