INSTALL.txt review.
[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 * The GNU C compiler gcc is recommended.
10 * Standard development utilities are required, such as `make' (install XCode command line tools on Mac OS).
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 within the Faustine directory, do:
21
22 ./configure
23
24 2- From within the Faustine directory, do:
25
26 make
27
28 This builds Faustine interpreter (and an adhoc Faust multirate preprocessor).
29 This phase is fairly verbose; consider redirecting the output to a file:
30
31 make > makelog.txt
32
33 3- From within the Faustine directory, do:
34
35 sudo make install
36
37 This installs Faustine interpreter and libraries (by default in /usr/local/bin and /usr/local/lib).
38
39 4- (Optional) To be test things work well, you can try to
40 test -- that is, to process a sine wave with
41 the newly created interpreter. From the Faustine directory, do:
42
43 make test
44
45
46
47 -- Karim Barkati and Haisheng Wang, MINES ParisTech, 2013