User Manual first draft.

[Faustine.git] / INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
index 692d4fb..ebfb17d 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -5,9 +5,9 @@ Installing Faustine on a Unix machine
 PREREQUISITES
 -------------
 
 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).

 * The GNU C compiler gcc is recommended.
 * 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
 
 
 INSTALLATION INSTRUCTIONS


@@ -17,33 +17,31 @@ INSTALLATION INSTRUCTIONS
 
         git clone https://scm.cri.ensmp.fr/git/Faustine.git
 
 
         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
 
 
         ./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
 
 
         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
 
 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
 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
 
 
 
 
         make test
 
 
 

--- Karim Barkati and Haisheng Wang, 2013
+-- Karim Barkati and Haisheng Wang, MINES ParisTech, 2013