Readme and Install files lifting.
[Faustine.git] / INSTALL
1 Installing Faustine on a Unix machine
2 =====================================
3
4
5 PREREQUISITES
6 -------------
7
8 * Faust is needed (tested version: 0.9.44).
9 * OCaml is needed (tested version: 4.00.1).
10 * The external "libsndfile-ocaml" OCaml module is needed.
11 * The GNU C compiler gcc is recommended.
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 the top directory, do:
22
23 ./configure
24
25 This generates the configuration file "Makefile".
26 You will be asked for include paths:
27 * OCaml path
28 * libsndfile-ocaml path
29
30
31 2- From the top directory, do:
32
33 make
34
35 This builds Faustine interpreter and Faust compiler 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