diff --git a/README.md b/README.md index 981c74b..8eedd50 100644 --- a/README.md +++ b/README.md @@ -176,10 +176,12 @@ Assuming you have started `mimic3-server` and can access `http://localhost:59125 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/). +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`. diff --git a/mimic3-http/README.md b/mimic3-http/README.md index d7ed89e..7c45ffd 100644 --- a/mimic3-http/README.md +++ b/mimic3-http/README.md @@ -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`. diff --git a/mimic3-tts/README.md b/mimic3-tts/README.md index 2c1ad71..6e67e03 100644 --- a/mimic3-tts/README.md +++ b/mimic3-tts/README.md @@ -56,7 +56,7 @@ curl --output - 'https://www.gutenberg.org/files/11/11-0.txt' | \ #### Multiple WAV Output -With `--output-dir` set to a directory, Larynx will output a separate WAV file for each sentence: +With `--output-dir` set to a directory, Mimic 3 will output a separate WAV file for each sentence: ```sh mimic3 'Test 1. Test 2.' --output-dir /path/to/wavs