indymedia
/
epicyon
mirror of https://gitlab.com/bashrc2/epicyon
7
4
Fork 1
Code Issues 14 Releases Wiki Activity

Update documentation for new option name

merge-requests/30/head
Bob Mottram 2021-03-16 22:32:19 +00:00
parent 55d4144c92
commit 34efc15f55
2 changed files with 16 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README_commandline.md
View File

@ -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. On Debian based systems you will need to have the **python3-espeak** package installed.
``` bash ``` 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: Or if you have [picospeaker](https://gitlab.com/ky1e/picospeaker) installed:
``` bash ``` 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. 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 ~/epicyon-client
``` ```
To run it with text-to-speech via espeak:
You can run a desktop client as follows:
``` bash ``` 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 ``` bash
quit Exit from the notification client quit Exit from the notification client

7
install-desktop-client
View File

@ -121,9 +121,14 @@ cp ~/epicyon-client ~/epicyon-client-tts
chmod +x ~/epicyon-client-tts chmod +x ~/epicyon-client-tts
sed -i 's|epicyon.py|epicyon.py --screenreader espeak|g' ~/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 cp ~/epicyon-client ~/epicyon-client-pico
chmod +x ~/epicyon-client-pico chmod +x ~/epicyon-client-pico
sed -i 's|epicyon.py|epicyon.py --screenreader picospeaker|g' ~/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" zenity --info --width=400 --text "Epicyon desktop client is now installed. You can run it with ~/epicyon-client"