add ubuntu install instructions

[i3/i3lock] / README.md

diff --git a/README.md b/README.md
index 352f4605b7b9a8eb5f16c4b4b66788859a25d97e..f6430e91d7a79fb13c8d9aa465325d755d85ea5d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,6 +18,15 @@ 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.
 
+Running i3lock
+-------------
+Ubuntu:
+```
+sudo apt-get install i3lock
+```
+
+For other operating systems, see Requirements and Building below.
+
 Requirements
 ------------
 - pkg-config
@@ -26,6 +35,7 @@ Requirements
 - libpam-dev
 - libcairo-dev
 - libxcb-xinerama
+- libxcb-randr
 - libev
 - libx11-dev
 - libx11-xcb-dev
@@ -40,6 +50,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