]> git.djapps.eu Git - pkg/ggml/sources/whisper.cpp/commitdiff
yt-wsp.sh : improve usage instructions
authorGeorgi Gerganov <redacted>
Wed, 7 Dec 2022 20:12:08 +0000 (22:12 +0200)
committerGeorgi Gerganov <redacted>
Wed, 7 Dec 2022 20:12:08 +0000 (22:12 +0200)
examples/yt-wsp.sh

index 784175c60b24006738a0c3dc6bcf7b2ffcb05d1b..b700d0872f4ca36e4f127f3855be724b80be1911 100755 (executable)
@@ -2,7 +2,15 @@
 
 # Small shell script to more easily automatically download and transcribe live stream VODs.
 # This uses YT-DLP, ffmpeg and the CPP version of Whisper: https://github.com/ggerganov/whisper.cpp
-# Use `./yt-wsp help` to print help info.
+# Use `./examples/yt-wsp.sh help` to print help info.
+#
+# Sample usage:
+#
+#   git clone https://github.com/ggerganov/whisper.cpp
+#   cd whisper.cpp
+#   make
+#   ./examples/yt-wsp.sh https://www.youtube.com/watch?v=1234567890
+#
 
 # MIT License
 
@@ -43,7 +51,7 @@ cleanup() {
 }
 
 print_help() {
-    echo "Usage: ./yt-wsp <video_url>"
+    echo "Usage: ./examples/yt-wsp.sh <video_url>"
     echo "See configurable env variables in the script"
     echo "This will produce an MP4 muxed file called res.mp4 in the working directory"
     echo "Requirements: ffmpeg yt-dlp whisper"
@@ -65,7 +73,14 @@ check_requirements() {
     if ! command -v "$WHISPER_EXECUTABLE" &>/dev/null; then
         WHISPER_EXECUTABLE="./main"
         if ! command -v "$WHISPER_EXECUTABLE" &>/dev/null; then
-            echo "Whisper is required (https://github.com/ggerganov/whisper.cpp)."
+            echo "Whisper is required (https://github.com/ggerganov/whisper.cpp):"
+            echo "Sample usage:"
+            echo ""
+            echo "  git clone https://github.com/ggerganov/whisper.cpp"
+            echo "  cd whisper.cpp"
+            echo "  make"
+            echo "  ./examples/yt-wsp.sh https://www.youtube.com/watch?v=1234567890"
+            echo ""
             exit 1
         fi
     fi