From 364eaf06102a061e9f111582f1fbbcb55c6c6acb Mon Sep 17 00:00:00 2001 From: Ayo Date: Thu, 4 Sep 2025 10:15:47 +0200 Subject: [PATCH] chore: update readme --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a1a0474..3928702 100644 --- a/README.md +++ b/README.md @@ -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]