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

Update documentation for password option

merge-requests/21/head
Bob Mottram 2021-03-13 11:44:03 +00:00
parent 398bd246f5
commit 30520ee636
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README_commandline.md
View File

@ -398,25 +398,27 @@ 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 --password [yourpassword] python3 epicyon.py --speaker 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 --screenreader picospeaker --notify yournickname@yourdomain --password [yourpassword] python3 epicyon.py --screenreader picospeaker --notify yournickname@yourdomain
``` ```
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.
## Desktop notifications ## Desktop notifications
You can get desktop notifications either by running the screen reader as shown above, or if you only want notifications and not spoken messages then you can run the client as follows, without the *screenreader* option: You can get desktop notifications either by running the screen reader as shown above, or if you only want notifications and not spoken messages then you can run the client as follows, without the *screenreader* option:
``` bash ``` bash
python3 epicyon.py --notify yournickname@yourdomain --password [yourpassword] python3 epicyon.py --notify yournickname@yourdomain
``` ```
You can also use the **--password** option if needed.
The notifications client also provides a number of basic commands, which may be more convenient than the web interface for some purposes: The notifications client also provides a number of basic commands, which may be more convenient than the web interface for some purposes:
``` bash ``` bash