From: Ben Harris Date: Thu, 27 Dec 2018 19:21:28 +0000 (+0000) Subject: README update. X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~bjharris/git?a=commitdiff_plain;h=794cc417bc234b7e603327ced72d3c4697d37b1a;p=clunk.git README update. --- diff --git a/README b/README index 5849875..ba1b774 100644 --- a/README +++ b/README @@ -1,6 +1,11 @@ -Clunk might one day be a program for driving an impulse electric clock -from a GPIO line. +Clunk is a program for driving an impulse electric clock from a GPIO +line. -The general plan is to generate a pulse every 30 s (at 0 s and 30 s -past each minute), with extra magic to adjust the clock at startup and -at the start and end of summer time. +Clunk generates a pulse every 30 s (at 0 s and 30 s past each minute), +with extra magic to adjust the clock at startup and at the start and +end of summer time. + +Clunk can safely be run as root, but it can also run with fewer +privileges as long as it has read-write access to its state file and +to the configured GPIO device. The supplied systemd unit file +demonstrates one way to run it with lower privilege.