diff --git a/README.md b/README.md index a3c4ec1..51d24d8 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,26 @@ -slock - simple screen locker -============================ +# slock - simple screen locker + simple screen locker utility for X. ![slock](https://i.imgur.com/foiK0uR.gif) -Requirements ------------- +## Requirements + In order to build slock you need the Xlib header files. -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 +```sh +make clean install +``` +## Running slock -Running slock -------------- Simply invoke the 'slock' command. To get out of it, enter your password.