Merge pull request #213 from trickeydan/patch-1

[i3/i3lock] / README.md

diff --git a/README.md b/README.md
index fc486b238389255554039b3833939b19627391fb..af3fd0b7350102d9663c4e34f6fbb14ed9f6d868 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,8 @@
 i3lock - improved screen locker
 ===============================
-i3lock is a simple screen locker like slock. After starting it, you will
-see a white screen (you can configure the color/an image). You can return
-to your screen by entering your password.
+[i3lock](https://i3wm.org/i3lock/)> is a simple screen locker like slock.
+After starting it, you will see a white screen (you can configure the
+color/an image). You can return to your screen by entering your password.
 
 Many little improvements have been made to i3lock over time:
 
@@ -18,6 +18,11 @@ Many little improvements have been made to i3lock over time:
 - i3lock uses PAM and therefore is compatible with LDAP etc.
   On OpenBSD i3lock uses the bsd_auth(3) framework.
 
+Install
+-------
+
+See [the i3lock home page](https://i3wm.org/i3lock/).
+
 Requirements
 ------------
 - pkg-config
@@ -25,8 +30,8 @@ Requirements
 - libxcb-util
 - libpam-dev
 - libcairo-dev
-- libxcb-composite0
 - libxcb-xinerama
+- libxcb-randr
 - libev
 - libx11-dev
 - libx11-xcb-dev
@@ -41,6 +46,27 @@ 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