diff --git a/README b/README index dd6b659..0c30af6 100644 --- a/README +++ b/README @@ -1,9 +1,9 @@ -slock - simple screen locker -============================ -simple screen locker utility for X. +# slock - a fork of the suckless screenlocker for the _extremely_ paranoid -Changes by chjj ------------- +This is my personal fork of slock. It is the only screenlocker secure enough +for me to use. + +## Changes from the original Slock - Custom Password: You can provide a custom password so you don't have to enter your user password on the X server. Simply create a ~/.slock_passwd file with @@ -47,22 +47,25 @@ Changes by chjj You must change [username] and [hostname] to your username and the hostname of the machine. -Requirements ------------- +## Requirements + In order to build slock you need the Xlib header files. +- Potential runtime deps: sudo, ffmpeg, setxkbmap, curl, aplay +- Other potential requirements: a twilio account, an imgur account + +## Installation -Installation ------------- Edit config.mk to match your local setup (slock is installed into the /usr/local namespace by default). Afterwards enter the following command to build and install slock (if necessary as root): - make clean install +``` bash +$ make clean install +``` +## Running slock -Running slock -------------- Simply invoke the 'slock' command. To get out of it, enter your password.