From 4e117d78f8e4923d74c0af686e3456f4685d478f Mon Sep 17 00:00:00 2001 From: vikingowl Date: Tue, 12 Aug 2025 06:00:07 +0200 Subject: [PATCH] Revert "[docs] update README with new CLI options, usage tips, and guidance for language models" This reverts commit af473c494266ededde688f2387b36a94c7872ab4. --- README.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5795517..a6b228b 100644 --- a/README.md +++ b/README.md @@ -30,12 +30,8 @@ Quickstart - ./target/release/polyscribe --download-models 2) Transcribe a file: -- ./target/release/polyscribe -v -o output --out-format json --jobs 4 my_audio.mp3 -This writes JSON (because of --out-format json) into the output directory with a date prefix. Omit --out-format to write all available formats (JSON and SRT). For large batches, add --continue-on-error to skip bad files and keep going. - -Gotchas -- English-only models: If you picked an English-only Whisper model (e.g., tiny.en, base.en), non-English language hints (via --language) will be rejected and detection may be biased toward English. Use a multilingual model (without the .en suffix) for non-English audio. -- Language hints help: When you know the language, pass --language (e.g., --language de) to improve accuracy and speed. If the audio is mixed language, omit the hint to let the model detect. +- ./target/release/polyscribe -v -o output my_audio.mp3 +This writes JSON and SRT into the output directory with a date prefix. Shell completions and man page - Completions: ./target/release/polyscribe completions > polyscribe.