diff options
| author | historia <historiavg@proton.me> | 2026-08-24 02:59:26 -0400 |
|---|---|---|
| committer | historia <historiavg@proton.me> | 2026-08-24 02:59:26 -0400 |
| commit | f00249db9d1ea051d29aa1bcca869fc4b88e83eb (patch) | |
| tree | a75f076fac1b63e0b4bf2eb8f54affbcc681a891 /README.md | |
| parent | 9dd4f9595be3b1d76a3a07dc3eca90cfaf8a3f97 (diff) | |
| download | tts-audiobook-generator-f00249db9d1ea051d29aa1bcca869fc4b88e83eb.tar.gz | |
refactor: add app directory, dir structure change
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 9 insertions, 9 deletions
@@ -21,7 +21,7 @@ The converter sends text extracted from your books to a locally running TTS serv ## Installation Clone the repo. No manual environment setup is needed — `audiobook.py` -creates and manages its own virtual environment (`envs/tts`) the first time +creates and manages its own virtual environment (`app/envs/tts`) the first time it runs, installing its requirements and any backend TTS packages into it. ```bash @@ -30,7 +30,7 @@ cd tts-audiobook-generator python audiobook.py ``` -On first launch `audiobook.py` creates `envs/tts` (via `python -m venv`), +On first launch `audiobook.py` creates `app/envs/tts` (via `python -m venv`), installs `requirements.txt` into it, and re-launches itself inside that environment. Backend packages (`qwen-tts`, `faster-qwen3-tts[demo]`) are pip-installed into the same venv by their setup wizards. @@ -39,7 +39,7 @@ To add extras manually (e.g. FlashAttention), pip-install into the managed venv directly: ```bash -envs/tts/bin/python -m pip install flash-attn +app/envs/tts/bin/python -m pip install flash-attn ``` Put your book files (epub, etc.) in the `input/` directory. The output goes to `output/`. @@ -61,7 +61,7 @@ A full-screen TUI opens and shows each backend's status in a table — **unavail **Configure a backend…** and **Server…** only appear once at least one backend is installed or running. -Everything the TUI does can also be scripted with flags: `python audiobook.py --backend audiocpp --model higgs --voice narrator`, or `python -m backends.audiocpp --families higgs_audio_tts --clone --build-backend cuda`. +Everything the TUI does can also be scripted with flags: `python audiobook.py --backend audiocpp --model higgs --voice narrator`, or `python app/backends/audiocpp.py --families higgs_audio_tts --clone --build-backend cuda`. You need one of the following backends (the TUI sets them up for you; manual steps below): @@ -90,15 +90,15 @@ You need one of the following backends (the TUI sets them up for you; manual ste | `--transcription "..."` | `qwen`: Override whisper auto-transcription with manual audio transcript. | | `--no-transcription` | `qwen`: Skip auto-transcription of the reference audio. | -Other options including backend server URLs/ports are configured in `converter/config.py` +Other options including backend server URLs/ports are configured in `app/converter/config.py` ## TTS Backend Setup -Installation and usage documentation for each supported TTS backend is in the `docs/` directory: +Installation and usage documentation for each supported TTS backend is in the `app/docs/` directory: -- [audio.cpp instructions](docs/backend-audiocpp.md) -- [qwen-tts instructions](docs/backend-qwen.md) -- [faster-qwen-tts instructions](docs/backend-faster.md) +- [audio.cpp instructions](app/docs/backend-audiocpp.md) +- [qwen-tts instructions](app/docs/backend-qwen.md) +- [faster-qwen-tts instructions](app/docs/backend-faster.md) ## Tips |