ayo/simple-tts
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme

Browse source
This commit is contained in:
Ayo Ayco 2025-09-06 10:00:08 +02:00
parent 973efa5b2c
commit 45eb804d90
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -21,14 +21,13 @@ This is especially useful for the days when I don't have the mental energy to go
## Requirements ## Requirements
**Simple TTS** is in early development, and not packaged or distributed yet for any particular operating system. Please read on to see the tested environment under which I am developing & using it: **Simple TTS** is in early development and not packaged or distributed yet for any particular operating system. Please read on to see the tested environment under which I am developing & using it.
1. **Debian or Ubuntu** - This is currently only tested working on Debian or Ubuntu-based distros. 1. **Debian or Ubuntu** - This is currently only tested working on Debian or Ubuntu-based distros.
1. **espeak-ng and vlc** - The following are required packages aside from the python dependencies. `espeak-ng` is used under the hood as a fallback engine for English languages, and `libvlc` is used as the default audio player for the generated audio. 1. **espeak-ng and vlc** - The following are required packages aside from the python dependencies. `espeak-ng` is used under the hood as a fallback engine for English languages, and `libvlc` is used as the default audio player for the generated audio.
1. **Up to 55GB of storage** - Because it is not yet packaged or compiled, the python dependencies and huggingface models are downloaded separately into your machine (within the python environment) and requires storage space. 1. **Up to 55GB of storage** - Because it is not yet packaged or compiled, the python dependencies and huggingface models are downloaded separately during the setup process into your machine.
1. **Updated drivers for accelerators** - GPU accelerators make the program run faster, but you need to have updated drivers for your device that `PyTorch` requires. However, it will still run fine on CPUs, just slower (up to 2x longer or more). 1. **Updated drivers for accelerators** - GPU accelerators make the program run faster, but you need to have updated drivers for your device that `PyTorch` requires. However, it will still run fine on CPUs, just slower (up to 2x longer or more).
## Setup ## Setup
First, install the required packages `espeak-ng` and `vlc`. First, install the required packages `espeak-ng` and `vlc`.
@ -69,7 +68,7 @@ pip install -r requirements.txt
### Language-specific setup ### Language-specific setup
For some languages, you might need to install specific python dependecies. For example, before you can use Chinese voices you have to install the requirements listed in `requirements-zh.txt`. For some languages, you might need to install specific python dependecies. For example, before you can use Chinese voices to read Mandarin text you have to install the requirements listed in `requirements-zh.txt`.
```bash ```bash
# Before using zf or zm prefixed voices... # Before using zf or zm prefixed voices...
@ -186,7 +185,7 @@ It is possible that the there are additional setup for a specific voice language
| -------------------- | --------- | ----------------------------- | | -------------------- | --------- | ----------------------------- |
| American English | 'a' | _non additional requirements_ | | American English | 'a' | _non additional requirements_ |
| British English | 'b' | _no additional requirements_ | | British English | 'b' | _no additional requirements_ |
| Chinese | 'z' | requirements-zh.txt | | Mandarin Chinese | 'z' | requirements-zh.txt |
| Japanese | 'j' | requirements-jp.txt | | Japanese | 'j' | requirements-jp.txt |
| Spanish | 'e' | _no additional requirements_ | | Spanish | 'e' | _no additional requirements_ |
| French | 'f' | _no additional requirements_ | | French | 'f' | _no additional requirements_ |