X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;ds=sidebyside;f=README.md;h=28d9fdba8c126683e8f3d2138f1d4c6f5ba52e71;hb=a355bed013c4e00bba468e130429358cc354177d;hp=fcecbfaca0df6074a424c22039a03dd26bd52e1b;hpb=80d4452ec680bcb0e57418f69d44d88ded82047c;p=i3%2Fi3lock

diff --git a/README.md b/README.md
index fcecbfa..28d9fdb 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,16 @@ Many little improvements have been made to i3lock over time:
 - You can specify whether i3lock should bell upon a wrong password.
 
 - i3lock uses PAM and therefore is compatible with LDAP etc.
+  On OpenBSD i3lock uses the bsd_auth(3) framework.
+
+Install
+-------
+Ubuntu:
+```
+sudo apt-get install i3lock
+```
+
+For other operating systems, see Requirements and Building below.
 
 Requirements
 ------------
@@ -24,8 +34,8 @@ Requirements
 - libxcb-util
 - libpam-dev
 - libcairo-dev
-- libxcb-composite0
 - libxcb-xinerama
+- libxcb-randr
 - libev
 - libx11-dev
 - libx11-xcb-dev
@@ -37,6 +47,30 @@ Running i3lock
 Simply invoke the 'i3lock' command. To get out of it, enter your password and
 press enter.
 
+On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
+authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
+
+Building i3lock
+---------------
+We recommend you use the provided package from your distribution. Do not build
+i3lock unless you have a reason to do so.
+
+First install the dependencies listed in requirements section, then run these
+commands (might need to be adapted to your OS):
+```
+autoreconf --force --install
+
+rm -rf build/
+mkdir -p build && cd build/
+
+../configure \
+  --prefix=/usr \
+  --sysconfdir=/etc \
+  --disable-sanitizers
+
+make
+```
+
 Upstream
 --------
 Please submit pull requests to https://github.com/i3/i3lock