From b46038848c33072c269e91517a644854de015ef6 Mon Sep 17 00:00:00 2001 From: Chris Guillott Date: Tue, 15 Aug 2017 10:30:16 -0400 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c8c5ffb..c38a359 100644 --- a/README.md +++ b/README.md @@ -63,8 +63,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. -Requirements ------------- +## Building + +Before you build - check and see if there's a packaged version available for your distro (there usually is, either in a community repo/PPA). + +If there's no packaged version available - think carefully, since you're using a forked screen locker at your own risk. + +If you don't understand what makefiles are and how they work, start reading [here](http://www.tldp.org/HOWTO/Software-Building-HOWTO-3.html). If you're building from source - make sure you're keeping up to date. + +### Required Packages - pkg-config - libxcb - libxcb-util @@ -79,6 +86,8 @@ Requirements - libxkbcommon >= 0.5.0 - libxkbcommon-x11 >= 0.5.0 +(On centos/RHEL/etc, the packages tend to look like `cairo-devel` instead of `libcairo-dev`. Use `yum provides \*/` to figure out what packages you need.) + ##### Ubuntu sudo apt-get install pkg-config libxcb1 libpam-dev libcairo-dev libxcb-composite0 libxcb-composite0-dev libxcb-xinerama0-dev libev-dev libx11-dev libx11-xcb-dev libxkbcommon0 libxkbcommon-x11-0 libxcb-dpms0-dev libxcb-image0-dev libxcb-util0-dev libxcb-xkb-dev libxkbcommon-x11-dev libxkbcommon-dev