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-04 10:15:47 +02:00
parent 384e65d198
commit 364eaf0610
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,6 +1,9 @@
# Simple TTS
A simple 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]
> This is currently only tested working on Ubuntu-based distros due to the [required packages](#required-packages).
## Setup
@ -30,11 +33,13 @@ $ conda activate tts
$ python -m pip install -r requirements.txt
```
Because `vlc` is used to automatically play the generated audio, you will have to install it:
### 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
$ sudo apt install vlc espeak-ng
```
> [!Note]