diff --git a/README.md b/README.md index c9e044c..1391892 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,23 @@ See [the tutorial](docs/linux-voice-assistant-2mic-install.md) to build a satell - All settings are persistent, retained by the MQTT broker and re-applied whenever the application restarts. + Enable MQTT by including the following run configuration entries: + + ```bash + script/run \ + --name 'Linux Voice Assistant' \ + --mqtt-host \ + --mqtt-port 1883 \ + --mqtt-username \ + --mqtt-password \ + --wake-word-dir wakewords/openWakeWord \ + --wake-word-dir wakewords \ + --stop-model stop \ + --audio-input-device seeed-2mic-voicecard \ + --audio-output-device alsa/plughw:CARD=seeed2micvoicec \ + --debug + ``` + ## Installation Install system dependencies (`apt-get`):