From 1a560f3117b4d834ca9a44d57fdcb9495e942b90 Mon Sep 17 00:00:00 2001
From: "loic.allegre" <loic.allegre@ensiie.fr>
Date: Fri, 9 Aug 2019 17:33:18 +0200
Subject: [PATCH] Documented extractWav.sh

---
 extractWav.sh | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/extractWav.sh b/extractWav.sh
index 59d2b02..17d6688 100644
--- a/extractWav.sh
+++ b/extractWav.sh
@@ -1,5 +1,26 @@
 #!/bin/bash
 
+
+##########################################################################################################
+#
+# COMMAND : extractWav.sh
+#
+# AUTHOR : Sting
+#
+# DESCRIPTION : CLI tool to extract audio from .mkv files and convert it to 1-channel WAV files
+#               Currently supported formats :
+#			- Video : .mkv files only, any codec supported by FFMPEG
+#			- Audio : AAC, FLAC, DTS, AC3, MP3 (MPEG), OPUS, VORBIS
+#
+# USE : ./extractWav.sh source_folder destination_folder
+#
+# REQUIREMENTS : Have FFMPEG and SoX installed (for audio/video decoding)
+#
+#
+##########################################################################################################
+
+
+
 USAGE_MESSAGE="usage : $0 source_folder dest_folder"
 if [ $# != 2 ]; then
         echo $USAGE_MESSAGE; exit 1;
-- 
GitLab