v1.0

README.md

@@ -6,20 +6,41 @@ LogStreamer est un logiciel permettant la diffusion sonore d'un fichier via un s
 ## Prérequis
 
 * python3
-* pigtail
-```
-pip3 install pigtail
-```
+* oggenc
 
 ## Utilisation
 
-* Ajuster les valeurs des constantes LOG et WAV_OUTPUT en fonction des besoins
-  * LOG: Le log à jouer
-  * WAV_OUTPUT: Le fichier wav de sortie                                                                                       
-  * MAX_DURATION: La durée maximale d'une note
-  * EXCLUDE: Les caractères dont les valeurs sont ajoutées à cette liste ne seront pas traités
-* Exécuter ```python3 logstreamer.py```
-* Lire le fichier wav résultant avec un lecteur audio supportant le format wav
+```
+logstreamer.py -h
+
+  usage: logstreamer.py [-h] --log LOG [--workdir WORKDIR] [--duration DURATION]
+                        [--amplitude AMPLITUDE] [--framerate FRAMERATE]
+                        [--adjust ADJUST ADJUST]
+                        [--exclude [EXCLUDE [EXCLUDE ...]]] --host HOST --port
+                        PORT --user USER --password PASSWORD --mount MOUNT
+                        [--protocol PROTOCOL]
+
+  optional arguments:
+    -h, --help            show this help message and exit
+    --log LOG             Le fichier de log à traiter (requis)
+    --workdir WORKDIR     Le répertoire de travail (défaut: /tmp)
+    --duration DURATION   La durée d'une note (défaut: 0.008)
+    --amplitude AMPLITUDE
+                          Le niveau sonore (défaut: 0.5)
+    --framerate FRAMERATE
+                          Le taux d'échantillonage (défaut: 44100)
+    --adjust ADJUST ADJUST
+                          Facteurs d'ajustement (défaut: 5000 20000)
+    --exclude [EXCLUDE [EXCLUDE ...]]
+                          Liste des caractères non traités (défaut: [])
+    --host HOST           Server Icecast2 (requis)
+    --port PORT           Port TCP sur lequel contacter le serveur Icecast2
+                          (requis)
+    --user USER           Nom d'utilisateur (requis)
+    --password PASSWORD   Mot de passe (requis)
+    --mount MOUNT         Point de montage Icecast2 (requis)
+    --protocol PROTOCOL   Protocol à utiliser (défaut: http)
+```
 
 ## TODO