From: eplanet <emeric.planet@gmail.com>
Date: Sun, 2 Dec 2018 11:15:46 +0000 (+0100)
Subject: Add build instructions
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=refs%2Fpull%2F208%2Fhead;p=i3%2Fi3lock

Add build instructions
---

diff --git a/README.md b/README.md
index 61f64d4..c6dd54d 100644
--- a/README.md
+++ b/README.md
@@ -41,6 +41,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