From: Karim Barkati <karimbarkati@gmail.com>
Date: Tue, 27 Aug 2013 17:10:10 +0000 (+0200)
Subject: Install, Readme and Changes files updated.
X-Git-Url: https://scm.cri.mines-paristech.fr/git/Faustine.git/commitdiff_plain/63ee8bb67299f017e4ab5cd087439457a2d38c38?ds=inline

Install, Readme and Changes files updated.
---

diff --git a/Changes.txt b/Changes.txt
new file mode 100644
index 0000000..abf42e7
--- /dev/null
+++ b/Changes.txt
@@ -0,0 +1,4 @@
+Faustine 0.01:
+--------------
+
+* First internal release.
diff --git a/INSTALL b/INSTALL.txt
similarity index 82%
rename from INSTALL
rename to INSTALL.txt
index 15636c0..692d4fb 100644
--- a/INSTALL
+++ b/INSTALL.txt
@@ -5,7 +5,6 @@ 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.
@@ -24,15 +23,16 @@ INSTALLATION INSTRUCTIONS
 
 This generates the configuration file "Makefile".
 You will be asked for include paths:
-* OCaml path
-* libsndfile-ocaml path
+* your OCaml path
+* your libsndfile-ocaml path
 
 
 2- From the top directory, do:
 
         make
 
-This builds Faustine interpreter and Faust compiler for the first time. 
+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
@@ -46,4 +46,4 @@ the newly created interpreter. From the top directory, do:
 
 
 
--- Karim Barkati and Haisheng Wang, 2013
\ No newline at end of file
+-- Karim Barkati and Haisheng Wang, 2013
diff --git a/README b/README.txt
similarity index 69%
rename from README
rename to README.txt
index 42a0b56..b0ff5d1 100644
--- a/README
+++ b/README.txt
@@ -24,22 +24,16 @@ Yann Orlarey, 2009:
 CONTENTS
 --------
 
-  Changes               what's new with each release
+  Changes.txt           what's new with each release
   INSTALL               instructions for installation
   LICENSE               license and copyright notice
-  Makefile              main Makefile
+  Makefile              main Makefile generated by configure
+  Makefile.in           main Makefile body
   README                this file
-  config/               autoconfiguration stuff
-  emacs/                OCaml editing mode and debugger interface for GNU Emacs
-  lex/                  lexer generator
-  otherlibs/            several external libraries
-  parsing/              syntax analysis
-  stdlib/               standard library
-  tools/                various utilities
-  toplevel/             interactive system
-  typing/               typechecking
-  utils/                utility libraries
-  yacc/                 parser generator
+  configure             configuration script
+  examples/             vector examples (fft, image processing...)
+  interpretor/          Faustine's interpretor source code
+  libs/                 external libraries
 
 
 INSTALLATION
@@ -74,4 +68,4 @@ Emacs Info files.  It is available on the World Wide Web, at
 
 
 
--- Karim Barkati and Haisheng Wang, 2013
\ No newline at end of file
+-- Karim Barkati and Haisheng Wang, 2013