From: Karim Barkati <karimbarkati@gmail.com>
Date: Fri, 23 Aug 2013 14:47:34 +0000 (+0200)
Subject: Readme and Install files lifting.
X-Git-Url: https://scm.cri.mines-paristech.fr/git/Faustine.git/commitdiff_plain/14bec4f1c7b97b6415f2816df7fd0d1ba9c95cf1?hp=--cc

Readme and Install files lifting.
---

14bec4f1c7b97b6415f2816df7fd0d1ba9c95cf1
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..15636c0
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,49 @@
+Installing Faustine on a Unix machine
+=====================================
+
+
+PREREQUISITES
+-------------
+
+* Faust is needed (tested version: 0.9.44).
+* 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:
+* OCaml path
+* libsndfile-ocaml path
+
+
+2- From the top directory, do:
+
+        make
+
+This builds Faustine interpreter and Faust compiler 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
\ No newline at end of file
diff --git a/Makefile.in b/Makefile.in
index c27a93f..7835f0e 100644
--- a/Makefile.in
+++ b/Makefile.in
@@ -22,7 +22,7 @@ mrproper: clean
 
 test: 
 	@rm -f $(OUTPUTSOUNDS_DIR)/output0.wav
-	@cd $(SRC_DIR) && ./faustine -csv -wav ../dsp_files/sin.dsp
+	@cd $(SRC_DIR) && ./faustine -d ../dsp_files/sin.dsp
 	@ls -l $(OUTPUTSOUNDS_DIR)/output0.wav
 
 	@echo "    You might want to check the output file with either:"
diff --git a/README b/README
index 3285a0d..42a0b56 100644
--- a/README
+++ b/README
@@ -1,7 +1,8 @@
 OVERVIEW
 ========
 
-MRFausti is an interpreter for multi-rate FAUST programs, written in OCaml.
+Faustine is an interpreter for multi-rate FAUST programs, written in OCaml,
+at CRI of MINES ParisTech.
 
 FAUST (Functional Audio Stream) is a functional programming language
 specifically designed for real-time signal processing and
@@ -9,13 +10,13 @@ synthesis. It targets high-performance signal processing applications
 and audio plug-ins for a variety of platforms and
 standards. <http://faust.grame.fr>
 
-MRFausti provides support for some vector features presented in the
+Faustine provides support for some vector features presented in the
 paper "Semantics for Multirate Faust", written by Pierre Jouvelot and
 Yann Orlarey, 2009:
 
 - vectorize 
 - serialize
-- [] (pick an element from a vector)
+- [ ] (pick an element from a vector)
 - # (concatenate two vectors)
 
 
@@ -44,26 +45,33 @@ CONTENTS
 INSTALLATION
 ------------
 
-See the file INSTALL for installation instructions on Unix, Linux and
-MacOS X machines.  For MS Windows, see README.win32.
+See the file INSTALL.
 
 
 UPDATE
 ------
 
+Faustine's git repository can be cloned with correct rights:
+git clone https://scm.cri.ensmp.fr/git/Faustine.git
 
 
 DOCUMENTATION
 -------------
 
-The FAUST documentation is available at
+* No specific documentation is provided for Faustine by now.
+Faustine's options can be seen calling "faustine --help".
+You can read "Semantics for Multirate Faust", Pierre Jouvelot and
+Yann Orlarey, 2009.
+
+* The FAUST documentation is available at
 
         http://faust.grame.fr
 
-The OCaml manual is distributed in HTML, PDF, Postscript, DVI, and
+* The OCaml manual is distributed in HTML, PDF, Postscript, DVI, and
 Emacs Info files.  It is available on the World Wide Web, at
 
         http://caml.inria.fr/
 
-git test
-Merge test
+
+
+-- Karim Barkati and Haisheng Wang, 2013
\ No newline at end of file