1 files changed, 22 insertions, 64 deletions
diff --git a/README.md b/README.md
index cb2cde9..dec2154 100644
--- a/README.md
+++ b/README.md
@@ -1,76 +1,34 @@
-i3lock - improved screen locker
+## i3lock-extended
-===============================
-[i3lock](https://i3wm.org/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-extended is a fork of i3lock (https://github.com/i3/i3lock).
+It was started by Simeon Simeonov (https://simeon.simeonov.no) as a small hack, 
+implementing a LED-clock on top of an existing and robust screensaver.
- i3lock forks, so you can combine it with an alias to suspend to RAM
+i3lock-extended adds some additional functionality and is a free-software
-  (run "i3lock && echo mem > /sys/power/state" to get a locked screen
+licenced under the GPL3+. Most of the code is copyrighted by Michael Stapelberg
-   after waking up your computer from suspend to RAM)
+under a different license. See LICENSE for more information\!
- You can specify either a background color or a PNG image which will be
+The original README.md file from i3lock, containing installation instructions
-  displayed while your screen is locked. Note that i3lock is not an image
+can be found as INSTALL.md.
-manipulation software. If you need to resize the image to fill the screen
-or similar, use existing tooling to do this before passing it to i3lock.
- You can specify whether i3lock should bell upon a wrong password.
- i3lock uses PAM and therefore is compatible with LDAP etc.
+### Additional features
-  On OpenBSD i3lock uses the bsd_auth(3) framework.
-Install
+- LED-clock
-------
+- Digital clock
+- Elapsed time since activation
+- Display-text
-See [the i3lock home page](https://i3wm.org/i3lock/).
+i3lock-extended includes all of the original code and features of i3lock.
-Requirements
+Please refer to the manual page for more details and information about the different parameters\!
------------
- pkg-config
- libxcb
- libxcb-util
- libpam-dev
- libcairo-dev
- libxcb-xinerama
- libxcb-randr
- libev
- libx11-dev
- libx11-xcb-dev
- libxkbcommon >= 0.5.0
- libxkbcommon-x11 >= 0.5.0
- libxcb-image
- libxcb-xrm
-Running i3lock
-------------
-Simply invoke the 'i3lock' command. To get out of it, enter your password and
-press enter.
-On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the
+### Versioning
-authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
-Building i3lock
+i3lock-extended will merge the changes and fixes coming to i3lock in the
---------------
+future.
-We recommend you use the provided package from your distribution. Do not build
-i3lock unless you have a reason to do so.
-First install the dependencies listed in requirements section, then run these
+In order to create more clarity the version format for i3lock-extended will be:
-commands (might need to be adapted to your OS):
+\<extended version starting from 1>.\<i3lock version that is merged in\>[a-z
-```
+extended revision if used].
-autoreconf --force --install
-rm -rf build/
-mkdir -p build && cd build/
-../configure \
-  --prefix=/usr \
-  --sysconfdir=/etc \
-  --disable-sanitizers
-make
-```
-Upstream
--------
-Please submit pull requests to https://github.com/i3/i3lock

diff --git a/README.md b/README.md index cb2cde9..dec2154 100644 --- a/README.md +++ b/README.md
@@ -1,76 +1,34 @@
1	i3lock - improved screen locker	1	## i3lock-extended
2	===============================
3	[i3lock](https://i3wm.org/i3lock/)> is a simple screen locker like slock.
4	After starting it, you will see a white screen (you can configure the
5	color/an image). You can return to your screen by entering your password.
6		2
7	Many little improvements have been made to i3lock over time:	3	i3lock-extended is a fork of i3lock (https://github.com/i3/i3lock).
		4	It was started by Simeon Simeonov (https://simeon.simeonov.no) as a small hack,
		5	implementing a LED-clock on top of an existing and robust screensaver.
8		6
9	- i3lock forks, so you can combine it with an alias to suspend to RAM	7	i3lock-extended adds some additional functionality and is a free-software
10	(run "i3lock && echo mem > /sys/power/state" to get a locked screen	8	licenced under the GPL3+. Most of the code is copyrighted by Michael Stapelberg
11	after waking up your computer from suspend to RAM)	9	under a different license. See LICENSE for more information\!
12		10
13	- You can specify either a background color or a PNG image which will be	11	The original README.md file from i3lock, containing installation instructions
14	displayed while your screen is locked. Note that i3lock is not an image	12	can be found as INSTALL.md.
15	manipulation software. If you need to resize the image to fill the screen
16	or similar, use existing tooling to do this before passing it to i3lock.
17		13
18	- You can specify whether i3lock should bell upon a wrong password.
19		14
20	- i3lock uses PAM and therefore is compatible with LDAP etc.	15	### Additional features
21	On OpenBSD i3lock uses the bsd_auth(3) framework.
22		16
23	Install	17	- LED-clock
24	-------	18	- Digital clock
		19	- Elapsed time since activation
		20	- Display-text
25		21
26	See [the i3lock home page](https://i3wm.org/i3lock/).	22	i3lock-extended includes all of the original code and features of i3lock.
27		23
28	Requirements	24	Please refer to the manual page for more details and information about the different parameters\!
29	------------
30	- pkg-config
31	- libxcb
32	- libxcb-util
33	- libpam-dev
34	- libcairo-dev
35	- libxcb-xinerama
36	- libxcb-randr
37	- libev
38	- libx11-dev
39	- libx11-xcb-dev
40	- libxkbcommon >= 0.5.0
41	- libxkbcommon-x11 >= 0.5.0
42	- libxcb-image
43	- libxcb-xrm
44		25
45	Running i3lock
46	-------------
47	Simply invoke the 'i3lock' command. To get out of it, enter your password and
48	press enter.
49		26
50	On OpenBSD the `i3lock` binary needs to be setgid `auth` to call the	27	### Versioning
51	authentication helpers, e.g. `/usr/libexec/auth/login_passwd`.
52		28
53	Building i3lock	29	i3lock-extended will merge the changes and fixes coming to i3lock in the
54	---------------	30	future.
55	We recommend you use the provided package from your distribution. Do not build
56	i3lock unless you have a reason to do so.
57		31
58	First install the dependencies listed in requirements section, then run these	32	In order to create more clarity the version format for i3lock-extended will be:
59	commands (might need to be adapted to your OS):	33	\<extended version starting from 1>.\<i3lock version that is merged in\>[a-z
60	```	34	extended revision if used].
61	autoreconf --force --install
62
63	rm -rf build/
64	mkdir -p build && cd build/
65
66	../configure \
67	--prefix=/usr \
68	--sysconfdir=/etc \
69	--disable-sanitizers
70
71	make
72	```
73
74	Upstream
75	--------
76	Please submit pull requests to https://github.com/i3/i3lock