]> git.sur5r.net Git - i3/i3lock/commitdiff
README is actually in markdown, so tell github that
authorMichael Stapelberg <michael@stapelberg.de>
Fri, 26 Dec 2014 20:03:12 +0000 (21:03 +0100)
committerMichael Stapelberg <michael@stapelberg.de>
Fri, 26 Dec 2014 20:03:12 +0000 (21:03 +0100)
README [deleted file]
README.md [new file with mode: 0644]

diff --git a/README b/README
deleted file mode 100644 (file)
index b587c27..0000000
--- a/README
+++ /dev/null
@@ -1,42 +0,0 @@
-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.
-
-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)
-
-- 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.
-
-- 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.4.0
-- libxkbcommon-x11 >= 0.4.0
-
-Running i3lock
--------------
-Simply invoke the 'i3lock' command. To get out of it, enter your password and
-press enter.
-
-Upstream
---------
-Please submit pull requests to https://github.com/i3/i3lock
diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..b587c27
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+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.
+
+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)
+
+- 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.
+
+- 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.4.0
+- libxkbcommon-x11 >= 0.4.0
+
+Running i3lock
+-------------
+Simply invoke the 'i3lock' command. To get out of it, enter your password and
+press enter.
+
+Upstream
+--------
+Please submit pull requests to https://github.com/i3/i3lock