aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index e759c1a..84b1b7b 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
![TUI demo](./app/demo.webp)
-Generate audiobooks from books (epub, txt, pdf) using text-to-speech backends such as `audio.cpp`, `qwen-tts`, and `SGLang-Omni`. TAG installs and manages requirements and backend servers automatically.
+Generate audiobooks from books (epub, txt, pdf) using text-to-speech backends such as `audio.cpp`, `qwen-tts`, and `SGLang-Omni`. TAG installs and manages requirements, backend servers, and TTS models automatically.
## Overview
@@ -123,6 +123,24 @@ Transcription affects the output a lot. The automatic Whisper transcript is not
Even tiny amounts of pause between phrases in the sample audio can have a big impact. Try increasing or decreasing them or find a sample with different cadence.
+## Uninstall
+
+Everything the tool installs lives inside the project folder — venvs, the audio.cpp checkout, cloned repos, downloaded models, logs, and generated audiobooks — so removing it removes all of that:
+
+```bash
+rm -rf tts-audiobook-generator
+```
+
+A few caches land in your home directory. Only delete these if you don't share them with other tools:
+
+- `~/.cache/huggingface/hub` — TTS model weights and Whisper transcription models (delete only the `models--*` directories to keep the rest)
+- `~/.cache/whisper` — OpenAI Whisper models (only used when the fallback transcriber runs)
+- `~/.cache/pip` — downloaded wheels (shared with pip itself)
+
+```bash
+rm -rf ~/.cache/huggingface/hub ~/.cache/whisper ~/.cache/pip
+```
+
## License
MIT