X-Git-Url: https://svn.cri.ensmp.fr/git/Faustine.git/blobdiff_plain/63ee8bb67299f017e4ab5cd087439457a2d38c38..refs/heads/Imre:/INSTALL.txt diff --git a/INSTALL.txt b/INSTALL.txt index 692d4fb..b7dff4e 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -1,13 +1,18 @@ Installing Faustine on a Unix machine ===================================== +VERSION : 1.0 + +===================================== + PREREQUISITES ------------- -* OCaml is needed (tested version: 4.00.1). -* The external "libsndfile-ocaml" OCaml module is needed. +* OCaml is needed (tested versions: 3.12.1, 4.00.1). +* Faust is needed (tested version: 0.9.24). * The GNU C compiler gcc is recommended. +* Standard development utilities are required, such as `make' (install XCode command line tools on Mac OS). INSTALLATION INSTRUCTIONS @@ -17,33 +22,31 @@ INSTALLATION INSTRUCTIONS git clone https://scm.cri.ensmp.fr/git/Faustine.git -1- Configure the system. From the top directory, do: +1- Configure the system. From within the Faustine directory, do: ./configure -This generates the configuration file "Makefile". -You will be asked for include paths: -* your OCaml path -* your libsndfile-ocaml path - - -2- From the top directory, do: +2- From within the Faustine directory, do: make -This builds Faustine interpreter (and an adhoc Faust multirate preprocessor) -for the first time. +This builds Faustine interpreter (and an adhoc Faust multirate preprocessor). This phase is fairly verbose; consider redirecting the output to a file: make > makelog.txt +3- From within the Faustine directory, do: + + sudo make install + +This installs Faustine interpreter and libraries (by default in /usr/local/bin and /usr/local/lib). -3- (Optional) To be test things work well, you can try to +4- (Optional) To be test things work well, you can try to test -- that is, to process a sine wave with -the newly created interpreter. From the top directory, do: +the newly created interpreter. From the Faustine directory, do: make test --- Karim Barkati and Haisheng Wang, 2013 +-- Karim Barkati and Haisheng Wang, MINES ParisTech, 2013