v0.0.1

README.md

@@ -1,3 +1,26 @@
 # logstreamer
 
-LogStreamer est un logiciel permettant la diffusion sonore d'un fichier via un serveur Icecast
+LogStreamer est un logiciel permettant la diffusion sonore d'un fichier via un serveur Icecast
+
+
+## Prérequis
+
+* python3
+* pigtail
+```
+pip3 install pigtail
+```
+
+## 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
+
+## TODO
+
+* Gérer la diffusion vers un serveur Icecast avec ```python-shout```