diff --git a/README.md b/README.md index 3ff6cdc..e6d1ae8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,25 @@ # ButterSTT -A simple real-time speech to text application for the VRChat chatbox +A simple real-time speech to text application for the VRChat chatbox. -Using: +## Installation +- Download the zip and extract it into a folder. +- Download a model file from https://abb128.github.io/april-asr/models.html. + - Recommended: [april-english-dev-01110_en.april](https://april.sapples.net/april-english-dev-01110_en.april) +- Place the model file in the `Models` folder next to `ButterSTT.exe`. + +## Usage +- Run `ButterSTT.exe`, it will connect to VRChat OSC at `127.0.0.1:9000` by default. +- Optionally, configure the program by editing the values in `config.json`. + +## Credit + +### Using - - -- +- -Loosely based on: +### Loosely based on -