Refactor into a single package

mimic3_http/README.md

@@ -0,0 +1,57 @@
+# Mimic 3 Web Server
+
+A small HTTP web server for the [Mimic 3](https://github.com/MycroftAI/mimic3) text to speech system.
+
+[Available voices](https://github.com/MycroftAI/mimic3-voices)
+
+![screenshot of web interface](img/server_screenshot.jpg)
+
+
+## Running the Server
+
+``` sh
+mimic3-server
+```
+
+This will start a web server at `http://localhost:59125`
+
+See `mimic3-server --debug` for more options.
+
+
+### Endpoints
+
+* `/api/tts`
+    * `POST` text or [SSML](#ssml) and receive WAV audio back
+    * Use `?voice=` to select a different [voice/speaker](#voice-keys)
+    * Set `Content-Type` to `application/ssml+xml` (or use `?ssml=1`) for [SSML](#ssml) input
+* `/api/voices`
+    * Returns a JSON list of available voices
+
+An [OpenAPI](https://www.openapis.org/) test page is also available at `http://localhost:59125/openapi`
+
+
+### CUDA Acceleration
+
+If you have a GPU with support for CUDA, you can accelerate synthesis with the `--cuda` flag. This requires you to install the [onnxruntime-gpu](https://pypi.org/project/onnxruntime-gpu/) Python package.
+
+Using [nvidia-docker](https://github.com/NVIDIA/nvidia-docker) is highly recommended. See the `Dockerfile.gpu` file in the parent repository for an example of how to build a compatible container.
+
+
+## Running the Client
+
+Assuming you have started `mimic3-server` and can access `http://localhost:59125`, then:
+
+``` sh
+mimic3 --remote --voice 'en_UK/apope_low' 'My hovercraft is full of eels.' > hovercraft_eels.wav
+```
+
+If your server is somewhere besides `localhost`, use `mimic3 --remote <URL> ...`
+
+See `mimic3 --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`.