Add LISEZMOI

change README

git-svn-id: http://svn.parisson.org/svn/CNAQ/trunk@134 5fc3e0e6-29bc-4d03-b52b-c088cb822bde

diff --git a/LISEZMOI b/LISEZMOI
new file mode 100644 (file)
index 0000000..07b4ecb
--- /dev/null
+++ b/LISEZMOI
@@ -0,0 +1,68 @@
+# LISEZMOI\r
+# ========\r
+\r
+CNAQ : un module d'acquisition sous MATLAB pour mesurer les fonctions de transfert à travers des cartes audio.\r
+\r
+\r
+# 1. Introduction\r
+# ===============\r
+\r
+CNAQ est un logiciel dédié à la mesure de fonctions de transfert des systèmes électriques ou électrodynamiques. \r
+Ecrit en langage Matlab, il permet d'utiliser une carte d'acquisition audio compatible avec la norme ASIO pour \r
+générer un signal de type sinus glissant ("sweep" ou "chirp" en anglais), de quantifier la réponse temporelle \r
+du système puis d'en déterminer sa réponse fréquentielle.\r
+\r
+La structure d'analyse de CNAQ utilise la méthode d'Angelo Farina qui, appliquée dans le domaine numérique, \r
+permet d'obtenir des réponses avec un grand nombre d'échantillons, même à très basse fréquence, tout en suivant \r
+les harmoniques créés au cours du glissement en fréquence. Le calcul est en effet basé sur un produit de convolution \r
+dont la transformée de Fourier comporte le même nombre de points que le nombre d'échantillons dans le signal mesuré. \r
+Outre le fait que cette technique offre une souplesse d'utilisation supplémentaire par rapport aux autres méthodes, \r
+MLS par exemple, elle fournit des résolutions fréquentielles très grandes, notamment aux basses fréquences. \r
+Elle rend également très aisée et rapide la déduction des taux de distortions du système mesuré.\r
+\r
+Le logiciel CNAQ offre ainsi une interface interactive pour mesurer et calculer les fonctions de transfert \r
+directement dans Matlab. Il s'inspire entre autres de l'excellent logiciel libre QLoud http://gaydenko.com/qloud \r
+fonctionnant sur système GNU/Linux. \r
+\r
+\r
+# 2. Installation\r
+# ===============\r
+\r
+Décompressez l'archive de type zip ou tar.gz dans un dossier donné.\r
+\r
+# 3. Licence\r
+# ===============\r
+\r
+Ce logiciel libre CNAQ est régi par la licence CeCILL v2 soumise au droit français et respectant les principes \r
+de diffusion des logiciels libres. Vous pouvez utiliser, modifier et/ou redistribuer ce programme sous les conditions \r
+de la licence CeCILL telle que diffusée par le CEA, le CNRS et l'INRIA sur le site http://www.cecill.info. \r
+Ces termes sont également disponibles à l'adresse suivante : http://svn.parisson.org/cnaq/CnacqLicense\r
+\r
+\r
+# 4. Usage\r
+# =========\r
+\r
+Before using CNAQ, you have to read and edit the ASIO config file (config/ASIO.m).\r
+The latency value can to be computed with the get_latency function (tools/get_latency.m).\r
+\r
+When configuration is done, simply open CNAQ.m in Matlab and run it (F5)...\r
+\r
+ \r
+# 5. Auteurs\r
+# =========\r
+\r
+Guillaume Pellerin <guillaume.pellerin@cnam.fr>\r
+Manuel Melon <melon@cnam.fr>\r
+\r
+\r
+# 6. Remerciements\r
+# ==================\r
+\r
+Philippe Herzog, Andrew Gadenko.\r
+\r
+\r
+# 7. Contact / Infos\r
+# ==================\r
+\r
+voir http://svn.parisson.org/cnaq/ pour plus de détails.\r
+\r

diff --git a/README b/README
index 1c90a45844592e53a2dbb61d8021beae0fb1d7b6..1d06248941cfa5d03cb3ee6796974c64b107d128 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
 # README\r
 # ======\r
 \r
-CNAQ : a Matlab acquisition tool for computing transfert function over ASIO cards\r
+CNAQ : a Matlab acquisition tool for computing transfert function over audio cards\r
 \r
 \r
 # 1. Introduction\r
@@ -21,7 +21,7 @@ Fonctionnalit
 # 2. Installation\r
 # ===============\r
 \r
-see INSTALL\r
+Uncompress the zip or the tarball in a given directory. \r
 \r
 \r
 # 3. License\r
@@ -35,7 +35,10 @@ are also available at http://svn.parisson.org/cnaq/CnacqLicense
 # 4. Usage\r
 # =========\r
 \r
-Just open CNAQ.m in Matlab and run it...\r
+Before using CNAQ, you have to read and edit the ASIO config file (config/ASIO.m).\r
+The latency value can to be computed with the get_latency function (tools/get_latency.m).\r
+\r
+When configuration is done, simply open CNAQ.m in Matlab and run it (F5)...\r
 \r
  \r
 # 5. Authors\r
@@ -48,7 +51,7 @@ Manuel Melon <melon@cnam.fr>
 # 6. Aknowledgements\r
 # ==================\r
 \r
-Manuel Melon, Andrew Gadenko, Philippe Herzog \r
+Philippe Herzog, Andrew Gadenko.\r
 \r
 \r
 # 7. Contact / Infos\r