From 47afb93c3ce5ea27a7761954d5f6ea06d4660e87 Mon Sep 17 00:00:00 2001 From: Georgi Gerganov Date: Wed, 7 Dec 2022 22:12:08 +0200 Subject: [PATCH] yt-wsp.sh : improve usage instructions --- examples/yt-wsp.sh | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/examples/yt-wsp.sh b/examples/yt-wsp.sh index 784175c6..b700d087 100755 --- a/examples/yt-wsp.sh +++ b/examples/yt-wsp.sh @@ -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 " + echo "Usage: ./examples/yt-wsp.sh " 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