Update README.md
This commit is contained in:
15
README.md
15
README.md
@@ -2,3 +2,18 @@
|
||||
This is a program which allows you to type or pipe through stdin, into a [Mimic3 API](https://github.com/MycroftAI/mimic3) instance.
|
||||
I wrote it mostly for use with a [Linux TTS Plugin](https://github.com/Minizbot2012/LinuxTTSPlugin)
|
||||
as Mimic3 is a nice TTS software.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
Usage: mimic3-keyboard [OPTIONS]
|
||||
|
||||
Options:
|
||||
--host <HOST> [default: http://tts.local:59125]
|
||||
-v, --voice <VOICE> [default: en_US/vctk_low#p236]
|
||||
-s, --ssml
|
||||
-r, --rate <LENGTH> [default: 1.2]
|
||||
-n, --noise <NOISE> [default: 0.33]
|
||||
-h, --help Print help information
|
||||
-V, --version Print version information
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user