From: Georgi Gerganov <redacted>
Date: Sat, 26 Nov 2022 08:22:42 +0000 (+0200)
Subject: minor : add comment for using "generate_karaoke.sh"
X-Git-Tag: upstream/1.7.4~1775
X-Git-Url: https://git.djapps.eu/?a=commitdiff_plain;h=c536ff40051502d5692cf3467d40add40a2ca45f;p=pkg%2Fggml%2Fsources%2Fwhisper.cpp

minor : add comment for using "generate_karaoke.sh"
---

diff --git a/examples/generate-karaoke.sh b/examples/generate-karaoke.sh
index c5e7c445..7062c9a0 100755
--- a/examples/generate-karaoke.sh
+++ b/examples/generate-karaoke.sh
@@ -1,5 +1,16 @@
 #!/bin/bash
 
+# Simple tool to record audio from the microphone and generate a karaoke video
+# Usage:
+#
+#  cd whisper.cpp
+#  make
+#
+#  ./examples/generate-karaoke.sh [model] [step_ms]
+#
+# Press Ctrl+C to stop recording
+#
+
 executable="./main"
 model="base.en"
 model_path="models/ggml-$model.bin"