Abhorrent_Anger
/
EyeStrainReminder
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Cleaned up readme

This commit is contained in:
Abhorrent_Anger 2021-01-18 22:25:30 +02:00
parent 28b19df465
commit 30feaf8a4b
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -1,23 +1,25 @@
# EyeStrainReminder
A small background tool to remind the user of the "20-20-20" rule. Uses system notifications and sound cues. Made primarily for GNU/Linux, but should theoretically work with other environments.
## Installation
A small background tool for reminding the user of the "20-20-20" rule. Uses system notifications and sound cues. Made primarily for GNU/Linux, but should theoretically work with other environments.
First, you might need these packages:
```
sudo apt-get install python-gobject libnotify-bin python-gst-1.0
```
Second, just install the tool and required [Python modules](setup.py) by cloning the repository and running:
Second, install the tool and required [Python modules](setup.py) by cloning the repository and running these lines, optionally with the --user flag:
```
cd EyeStrainReminder
pip install . --user
python3 -m pip install .
```
Run it simply with, or preferably put it to run on boot as:
Launch or set it to run from boot as:
```
$ eyestrainreminder
```
Optional parameters can be viewed through "$ eyestrainreminder -h". In short, it's possible to set a custom notification sound, mute the notification sound, turn off notifications by default and invert the tray icon colors.
In order to remove it, just run:
Optional parameters can be viewed through "$ eyestrainreminder -h". In short, it's possible to set a custom notification sounds, mute the notification sounds, turn off notifications by default and invert the tray icon colors.
## Uninstallation
For removal of the software run:
```
pip uninstall EyeStrainReminder
python3 -m pip uninstall EyeStrainReminder
```