From 18aec0b78e0ae089a0021612aa85ba69ac1f6e00 Mon Sep 17 00:00:00 2001 From: Rufei Zhou Date: Tue, 17 Jun 2025 03:15:18 -0700 Subject: [PATCH] docs --- README.md | 4 ++-- txtlyric_to_lrc/main.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 18e8c3f..91f6f1f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ txtlyric-to-lrc aligns lyrics to songs in the [lrc](https://en.wikipedia.org/wik This is a wrapper around [stable-ts](https://github.com/jianfch/stable-ts) ([whisper](https://github.com/openai/whisper)) that is designed to be used with known-good transcriptions like untimed song lyrics. -Lyrics are expected to be placed alongside media files in `txt` files, and lines of lyrics should be separated by newlines. Output files will be placed alongside media in `lrc` files. +Lyrics are expected to be placed alongside media files in `txt` files, and lines of lyrics (segments) should be separated by newlines. Output `lrc` files will be written out alongside the original `txt` and media files. ## How to Use ```sh @@ -15,7 +15,7 @@ Options: -h, --help Show this message and exit. -m, --model TEXT Which whisper model to use (choices are those of whisper.available_models) - -l, --language TEXT [required] + -l, --language TEXT What language the lyrics are in [required] ``` ## How to Develop diff --git a/txtlyric_to_lrc/main.py b/txtlyric_to_lrc/main.py index fc9aaca..b44db3d 100644 --- a/txtlyric_to_lrc/main.py +++ b/txtlyric_to_lrc/main.py @@ -19,7 +19,7 @@ song_file_extensions = set([ @click.command() @click.help_option("--help", "-h") @click.option('--model', '-m', default='small', help='Which whisper model to use (choices are those of whisper.available_models)') -@click.option('--language', '-l', required=True) +@click.option('--language', '-l', required=True, help='What language the lyrics are in') @click.argument('directory') def main(model, language, directory): print(f"Loading {model} model for use with language {language}...")