summaryrefslogtreecommitdiff
path: root/README
blob: d99afc31722a6b62b90aeeb5e38fa407206283a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Guardian is a terminal command that can be run to display an encouraging
messages on all pseudottys (basically any terminal emulator) on a machine. In
addition it controls a electronic "buddy" that blocks the keyboard to remind the
user to take a break from the computer once in a while.

Example Usage:
	guardian kitty "You can do it!" /dev/ttyUSB0
	guardian trees "You should take a walk" /dev/ttyS0
To raise the "buddy"'s arm again use:
	guardian raise /dev/ttyUSB0

parakoimomenos is a script that launches a random guardian alert based on a list
of tasks in ~/.guardian/tasks.

Example Usage, to set aside some time on self care every day
$ fcrontab -e
00 12 * * * parakoimomenos /dev/ttyUSB0 color

Acknoledgements:

The RS-232 library(https://www.teuniz.net/RS-232/) Teunis Van Beelen was used
under GPLv3 to communicate with the Arduino used to drive the "buddy".

LICENSE:

This software is free software and provided under the Gnu General Public License
version 3.