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-05 09:35:02 +02:00
parent 5d4b56002b
commit 7085e0d006
1 changed files with 15 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -2,8 +2,21 @@
A simple machine learning text-to-speech program powered by [kokoro](https://huggingface.co/hexgrad/Kokoro-82M). A simple machine learning text-to-speech program powered by [kokoro](https://huggingface.co/hexgrad/Kokoro-82M).
> [!Warning] ## Requirements
> This is currently only tested working on Ubuntu-based distros due to the [required packages](#required-packages). This is in early development, and not packaged or distributed yet for any particular operating system. Please read on to see the tested environment I am developing & using it on
1. This is currently only tested working on Debian or Ubuntu-based distros.
1. 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. The following are required packages aside from the python dependencies. `espeak-ng` is used by `kokoro` under the hood as a fallback engine for English languages, and `libvlc` is used as the default audio player for the generated audio.
```bash
sudo apt update
sudo apt install vlc espeak-ng
```
> [!Note]
> Installing `vlc` via flatpak or snap will not work, as the code need access to `libvlc`.
## Setup ## Setup
@ -33,17 +46,6 @@ conda activate tts
python -m pip install -r requirements.txt python -m pip install -r requirements.txt
``` ```
### Required packages
The following are required packages aside from the python dependencies. `espeak-ng` is used by `kokoro` under the hood for english languages, and `libvlc` is used as the default audio player for the generated audio.
```bash
sudo apt update
sudo apt install vlc espeak-ng
```
> [!Note]
> Installing `vlc` via flatpak or snap will not work, as the code need access to `libvlc`.
### Intel XPU environmental variables (Optional) ### Intel XPU environmental variables (Optional)