From 30feaf8a4bdc5c42739c311f460c05989fc81009 Mon Sep 17 00:00:00 2001 From: Abhorrent_Anger Date: Mon, 18 Jan 2021 22:25:30 +0200 Subject: [PATCH] Cleaned up readme --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 450636c..23705d3 100644 --- a/README.md +++ b/README.md @@ -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 ``` \ No newline at end of file