Bugfix: Copy the color depth from parent (root) window instead of hardcoding to 24...

[i3/i3lock] / README

diff --git a/README b/README
index 2e70272ed70772a229ec1debd7a82e8f391b279e..f5fc2de2cb7d797a6fa24a7ef5a69e968c34615b 100644 (file)
--- a/README
+++ b/README
@@ -1,31 +1,35 @@
-i3lock - slightly improved screen locker based on slock
-============================
-i3lock improves slock by making it fork() and therefore combinable with
-commands to suspend your computer. Additionally, instead of turning of
-your screen via DPMS and/or displaying a black screen, i3lock displays a
-white screen so you can see if your computer failed to resume from suspend
-or if your screen is just locked. Also, when entering a wrong password,
-i3lock does not call XBell(). This is important because i3lock/slock think
-you’ve entered a password when resuming from suspend, at least sometimes.
-
-i3lock was forked from slock-0.9
+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.
 
-Requirements
-------------
-In order to build i3lock you need the Xlib header files.
+Many little improvements have been made to i3lock over time:
 
+- i3lock forks, so you can combine it with an alias to suspend to RAM
+  (run "i3lock && echo mem > /sys/power/state" to get a locked screen
+   after waking up your computer from suspend to RAM)
 
-Installation
-------------
-Edit config.mk to match your local setup (slock is installed into
-the /usr/local namespace by default).
+- You can specify either a background color or a PNG image which will be
+  displayed while your screen is locked.
 
-Afterwards enter the following command to build and install slock
-(if necessary as root):
+- You can specify whether i3lock should bell upon a wrong password.
 
-    make clean install
+- i3lock uses PAM and therefore is compatible with LDAP etc.
 
+Requirements
+------------
+- pkg-config (or you can rewrite the Makefile by hand if you want to avoid it)
+- libxcb
+- libxcb-util
+- libpam-dev
+- libcairo-dev
 
 Running i3lock
 -------------
 Simply invoke the 'i3lock' command. To get out of it, enter your password.
+
+Building i3lock
+-------------
+If you don't want to build against libcairo run "make NOLIBCAIRO=y", without
+libcairo displaying images is not possible.