Use cairo_status_to_string for descriptive errors.

[i3/i3lock] / README

diff --git a/README b/README
index 13628e3f8097d8e306d5970c217415f2613d18e1..41c1e4a809d78ba2bb7265c3b4347d83ac0af832 100644 (file)
--- a/README
+++ b/README
@@ -1,31 +1,41 @@
-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 off
-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
+- libxcb
+- libxcb-util
+- libpam-dev
+- libcairo-dev
+- libxcb-xinerama
+- libev
+- libx11-dev
+- libx11-xcb-dev
+- libxkbfile-dev
+- libxkbcommon >= 0.2.0
 
 Running i3lock
 -------------
-Simply invoke the 'i3lock' command. To get out of it, enter your password.
+Simply invoke the 'i3lock' command. To get out of it, enter your password and
+press enter.
+
+Upstream
+--------
+Please submit patches to http://cr.i3wm.org/