chiark / gitweb /
README update.
authorBen Harris <bjh21@bjh21.me.uk>
Thu, 27 Dec 2018 19:21:28 +0000 (19:21 +0000)
committerBen Harris <bjh21@bjh21.me.uk>
Thu, 27 Dec 2018 19:21:28 +0000 (19:21 +0000)
README

diff --git a/README b/README
index 58498753da5a79f1f9d48f500730dd031fa750a4..ba1b774e8713ab88ce94ae592421ca89caf672de 100644 (file)
--- 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.