From 34efc15f55b6ac4b062e365a8050a80283209308 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Tue, 16 Mar 2021 22:32:19 +0000 Subject: [PATCH] Update documentation for new option name --- README_commandline.md | 17 ++++++++++------- install-desktop-client | 7 ++++++- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README_commandline.md b/README_commandline.md index 73f9e46c9..9b41c423d 100644 --- a/README_commandline.md +++ b/README_commandline.md @@ -400,13 +400,13 @@ It is possible to use text-to-speech to read your inbox as posts arrive. This ca On Debian based systems you will need to have the **python3-espeak** package installed. ``` bash -python3 epicyon.py --speaker yournickname@yourdomain +python3 epicyon.py --notifyShowNewPosts --screenreader espeak --desktop yournickname@yourdomain ``` Or if you have [picospeaker](https://gitlab.com/ky1e/picospeaker) installed: ``` bash -python3 epicyon.py --notifyShowNewPosts --screenreader picospeaker --client yournickname@yourdomain +python3 epicyon.py --notifyShowNewPosts --screenreader picospeaker --desktop yournickname@yourdomain ``` You can also use the **--password** option to provide the password. This will then stay running and incoming posts will be announced as they arrive. @@ -425,16 +425,19 @@ and run it with: ~/epicyon-client ``` - -You can run a desktop client as follows: +To run it with text-to-speech via espeak: ``` bash -python3 epicyon.py --client yournickname@yourdomain +~/epicyon-client-tts ``` -You can also use the **--password** option if needed. +or if you have picospeaker installed: -The desktop client also provides a number of commands, which may be more convenient than the web interface for some purposes: +``` bash +~/epicyon-client-pico +``` + +The desktop client has a few commands, which may be more convenient than the web interface for some purposes: ``` bash quit Exit from the notification client diff --git a/install-desktop-client b/install-desktop-client index a896d6af3..33931a932 100755 --- a/install-desktop-client +++ b/install-desktop-client @@ -121,9 +121,14 @@ cp ~/epicyon-client ~/epicyon-client-tts chmod +x ~/epicyon-client-tts sed -i 's|epicyon.py|epicyon.py --screenreader espeak|g' ~/epicyon-client-tts -# TTS version +# TTS version with picospeaker cp ~/epicyon-client ~/epicyon-client-pico chmod +x ~/epicyon-client-pico sed -i 's|epicyon.py|epicyon.py --screenreader picospeaker|g' ~/epicyon-client-pico +# TTS stream +cp ~/epicyon-client ~/epicyon-client-pico +chmod +x ~/epicyon-client-pico +sed -i 's|epicyon.py|epicyon.py --notifyShowNewPosts --screenreader espeak|g' ~/epicyon-client-stream + zenity --info --width=400 --text "Epicyon desktop client is now installed. You can run it with ~/epicyon-client"