docs

2025-06-17 03:15:18 -07:00
parent d0f15d15a8
commit 18aec0b78e
2 changed files with 3 additions and 3 deletions
@@ -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