jyapayne/mimic3
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README clean up

Browse source
This commit is contained in:
Michael Hansen 2022-03-31 17:12:59 -04:00
commit 8e053434fb
3 changed files with 24 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

24
mimic3-http/README.md
View file

@ -7,15 +7,16 @@ A small HTTP web server for the [Mimic 3](https://github.com/MycroftAI/mimic3) t
![screenshot of web interface](img/server_screenshot.jpg)
## Installation
## Running the Server
``` sh
mimic3-server
```
This will start a web server at `http://localhost:59125`
See `mimic3-server --debug` for more options.
## Endpoints
@ -28,5 +29,20 @@ A small HTTP web server for the [Mimic 3](https://github.com/MycroftAI/mimic3) t
An [OpenAPI](https://www.openapis.org/) test page is also available at `http://localhost:59125/openapi`
## Running the Client
Assuming you have started `mimic3-server` and can access `http://localhost:59125`, then:
``` sh
mimic3-client --voice 'en_UK/apope_low' 'My hovercraft is full of eels.' > hovercraft_eels.wav
```
See `mimic3-client --help` for more options.
## MaryTTS Compatibility
Use the Mimic 3 web server as a drop-in replacement for [MaryTTS](http://mary.dfki.de/), for example with [Home Assistant](https://www.home-assistant.io/integrations/marytts/).
Make sure to use a compatible [voice key](#voice-keys) like `en_UK/apope_low`.