aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJames Magahern <james@magahern.com>2019-01-27 22:58:56 -0800
committerJames Magahern <james@magahern.com>2019-01-27 22:58:56 -0800
commit107ef0ff7daa50e8e07298fd17ece34cff58ee1b (patch)
tree8f49540d5973c046638b32e6305510a15013323d /README.md
parentAnimate with easing function (diff)
Add README
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..db1887c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# the buzzert screen locker
+
+This is a graphical screen locker for X11, for use in conjunction with
+[XSecureLock](https://github.com/google/xsecurelock). It uses PAM for authentication,
+so you can use it with your Yubikey/fingerprint scanner, etc. as well.
+
+![buzzlocker screenshot](screenshots/buzzlocker.png "buzzlocker")
+
+## Building
+
+This project uses the Meson build system:
+
+
+```
+meson build
+ninja -C build
+```
+
+## Installing
+By building buzzlocker by itself, you'll end up with a binary called `auth_buzzlocker`.
+This is meant to be used in conjunction with [XSecureLock](https://github.com/google/xsecurelock),
+which does all the heavy-lifting with regards to properly locking an X session and ensuring other
+windows cannot steal focus or cause the locker to disappear somehow. It also handles secure keyboard
+input to make sure key events don't get delivered to applications in the background.
+
+If you run `auth_buzzlocker` by itself, you can preview what the screen locker looks
+like in windowed-form. If you want to use buzzlocker as your screen locker with XSecureLock,
+all you need to do is set the `XSECURELOCK_AUTH` environment variable to point to `auth_buzzlocker`.
+
+So you might want to do:
+1. `sudo ninja -C build install`
+2. `XSECURELOCK_AUTH=/usr/local/bin/auth_buzzlocker xsecurelock`
+
+If you want to make it permanent, edit `/etc/environment` to include this line:
+```
+XSECURELOCK_AUTH=/usr/local/bin/auth_buzzlocker xsecurelock
+```
+
+So every time you run `xsecurelock` by itself, it will use buzzlocker as the GUI.
+
+