]> git.sur5r.net Git - i3/i3lock/blobdiff - README
Ignore empty passwd after repeated Enter keypress
[i3/i3lock] / README
diff --git a/README b/README
index 8696241bb4c6067d28fc15673e720f8b20770518..41c1e4a809d78ba2bb7265c3b4347d83ac0af832 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ 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 passwords.
+to your screen by entering your password.
 
 Many little improvements have been made to i3lock over time:
 
@@ -10,8 +10,8 @@ Many little improvements have been made to i3lock over time:
   (run "i3lock && echo mem > /sys/power/state" to get a locked screen
    after waking up your computer from suspend to RAM)
 
-- You can either a background color or a PNG image which will be displayed
-  while your screen is locked.
+- You can specify either a background color or a PNG image which will be
+  displayed while your screen is locked.
 
 - You can specify whether i3lock should bell upon a wrong password.
 
@@ -19,12 +19,23 @@ Many little improvements have been made to i3lock over time:
 
 Requirements
 ------------
-- pkg-config (or you can rewrite the Makefile by hand if you want to avoid it)
+- 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/