X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/779f611208ea8ee7475df7729451f33104e1369a..11ce8ed0136112138606895754297454f4601e67:/README diff --git a/README b/README index 0dde336..4cb8ca4 100644 --- a/README +++ b/README @@ -6,7 +6,7 @@ slstatus is a suckless status monitor for window managers that use WM_NAME Features -------- -- Battery percentage/power/state +- Battery percentage/state - CPU usage - CPU frequency - Custom shell commands @@ -15,7 +15,7 @@ Features - Available entropy - Username/GID/UID - Hostname -- IP address +- IP address (IPv4 and IPv6) - Kernel version - Keyboard indicators - Load average @@ -30,14 +30,13 @@ Features Requirements ------------ -In order to build slstatus you need the Xlib header files and optionally ALSA -for volume percentage. PulseAudio is not supported for various reasons. +In order to build slstatus you need the Xlib header files. Installation ------------ Edit config.mk to match your local setup (slstatus is installed into the -/usr/local namespace by default). +/usr/local namespace by default). Uncomment OSSLIBS on OpenBSD. Afterwards enter the following command to build and install slstatus (if necessary as root): @@ -54,3 +53,8 @@ Configuration ------------- slstatus can be customized by creating a custom config.h and (re)compiling the source code. This keeps it fast, secure and simple. + + +Todo +---- +Cleaning up the whole codebase it the goal before thinking about a release.