update Rigel's readme

This commit is contained in:
Sameer Rahmani 2022-04-19 14:54:40 +01:00
parent 9371de61e3
commit 74f82154c4
1 changed files with 3 additions and 3 deletions

View File

@ -12,11 +12,11 @@ In order to use it, first you need to setup the project which you can just call
script like:
```bash
./builder rigel [path-to-.env-file]
./builder rigel [start|stop|status]
```
Rigel will listen to the tcp port provided by HOST and PORT vars in `.env` and
converts any text messages that gets into speech on the fly.
Rigel will listen to the tcp port provided by HOST and PORT vars in `.env`(at the root of
project) and converts any text messages that gets into speech on the fly.
The protocol is pretty simple. The packet should start with 32 bit unsigned
integer that contains the length of the string that comes after it. That's it.