User Manual first draft.

[Faustine.git] / README.txt

diff --git a/README.txt b/README.txt
index b0ff5d1..9dbbd8c 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -2,7 +2,8 @@ OVERVIEW
 ========
 
 Faustine 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.
+at CRI of MINES ParisTech, and covered by the GNU Public License V3 (see
+LICENSE.txt).

 
 FAUST (Functional Audio Stream) is a functional programming language
 specifically designed for real-time signal processing and
 
 FAUST (Functional Audio Stream) is a functional programming language
 specifically designed for real-time signal processing and


@@ -24,16 +25,16 @@ Yann Orlarey, 2009:
 CONTENTS
 --------
 
 CONTENTS
 --------
 

+  benchmarks/           benchmark result files

   Changes.txt           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 generated by configure
-  Makefile.in           main Makefile body
-  README                this file
-  configure             configuration script
+  configure             compilation configuration script

   examples/             vector examples (fft, image processing...)
   examples/             vector examples (fft, image processing...)

-  interpretor/          Faustine's interpretor source code
-  libs/                 external libraries
+  INSTALL.txt           Faustine installation instructions
+  interpreter/          Faustine's interpreter source code
+  lib/                  library files in Faustine (fft.lib, morpho.lib...)
+  LICENSE.txt           license and copyright notice
+  Makefile              main Makefile to compile and install
+  README.txt            this file

 
 
 INSTALLATION
 
 
 INSTALLATION


@@ -45,7 +46,7 @@ See the file INSTALL.
 UPDATE
 ------
 
 UPDATE
 ------
 

-Faustine's git repository can be cloned with correct rights:
+Faustine's git repository can be cloned (with correct rights):

 git clone https://scm.cri.ensmp.fr/git/Faustine.git
 
 
 git clone https://scm.cri.ensmp.fr/git/Faustine.git
 
 


@@ -68,4 +69,4 @@ Emacs Info files.  It is available on the World Wide Web, at
 
 
 
 
 
 

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