X-Git-Url: https://scm.cri.ensmp.fr/git/Faustine.git/blobdiff_plain/fc2ec49c325b99370170789886b4be4f43e16d68..b8e89a384896a4f8ce3e1990a10c88e7164af55c:/INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
new file mode 100644
index 0000000..692d4fb
--- /dev/null
+++ b/INSTALL.txt
@@ -0,0 +1,49 @@
+Installing Faustine on a Unix machine
+=====================================
+
+
+PREREQUISITES
+-------------
+
+* OCaml is needed (tested version: 4.00.1).
+* The external "libsndfile-ocaml" OCaml module is needed.
+* The GNU C compiler gcc is recommended.
+
+
+INSTALLATION INSTRUCTIONS
+-------------------------
+
+0- Faustine's git repository can be cloned calling:
+
+        git clone https://scm.cri.ensmp.fr/git/Faustine.git
+
+1- Configure the system. From the top 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:
+
+        make
+
+This builds Faustine interpreter (and an adhoc Faust multirate preprocessor) 
+for the first time. 
+This phase is fairly verbose; consider redirecting the output to a file:
+
+        make > makelog.txt
+
+
+3- (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:
+
+        make test
+
+
+
+-- Karim Barkati and Haisheng Wang, 2013