aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 11 insertions, 16 deletions
diff --git a/README.md b/README.md
index 0f0d090..9c52213 100644
--- a/README.md
+++ b/README.md
@@ -24,12 +24,11 @@ The converter sends text extracted from your books to a locally running Qwen3-TT
## Installation
-```bash
-# Arch Linux
-sudo pacman -S conda ffmpeg
+Install ffmpeg and conda, e.g.
-# Debian, conda must be installed separately
-sudo apt-get install ffmpeg
+```bash
+sudo pacman -S conda ffmpeg #Arch Linux
+sudo apt-get install ffmpeg #Debian, conda must be installed separately
```
### Install Qwen3-TTS (Server)
@@ -96,17 +95,13 @@ Whisper (`faster_whisper` or `whisper`) is used automatically to transcribe the
### Options
-| Flag | Description |
-| --------------------------- | ----------------------------------------------------------------------------------------- |
-| `--speed <n>` | Playback speed, pitch-preserving (`1.0` = normal). A normal-speed copy is also output. |
-| `--format {mp3,m4b}` | Output format (default `mp3`). `m4b` uses AAC audio and is always a single file. |
-| `--single-file` | Merge all chapters into a single mp3 (default: one mp3 per chapter). |
-| `--voice-sample-text "..."` | Transcript of the reference audio (voice clone only). |
-| `--no-transcription` | Skip auto-transcription of the reference audio (voice clone only). |
-
-Books with chapters (e.g. EPUB) are converted to **one mp3 per chapter** by default, named `output/<Book>_01_<Chapter>.mp3`, `output/<Book>_02_<Chapter>.mp3`, etc.; use `--single-file` to merge them. `m4b` output is always a single file with chapter markers embedded so listeners can skip between chapters. TXT and PDF files have no chapter structure and always produce a single file.
-
-The `chunks/` folder is scratch space for the current book only — it is emptied before and after every conversion, so an interrupted run never affects the next one.
+| Flag | Description |
+| --------------------------- | ----------------------------------------------------------------------------------------------------- |
+| `--speed <n>` | Playback speed, pitch-preserving (`1.0` = normal). A normal-speed copy is also output. |
+| `--format {mp3,m4b}` | Output format (default `mp3`). `m4b` uses AAC audio and has built-in chapters. |
+| `--single-file` | mp3 only: Merge all chapters into a single mp3 (default: one mp3 per chapter). |
+| `--voice-sample-text "..."` | Override whisper auto-transcription with your own manual reference audio transcript. Not required. |
+| `--no-transcription` | Skip auto-transcription of the reference audio. Usually worse, but can give a different voice affect. |
## Running tests