X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/8f5219b6dab5a1c9b7f92362a34aacfd393fa0e4..74891945d897530b30c2c29844808d63bff625b7:/README diff --git a/README b/README index 19f422e..c278599 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/time left - CPU usage - CPU frequency - Custom shell commands @@ -19,6 +19,7 @@ Features - Kernel version - Keyboard indicators - Load average +- Network speeds (RX and TX) - Number of files in a directory (hint: Maildir) - Memory status (free memory, percentage, total memory and used memory) - Swap status (free swap, percentage, total swap and used swap) @@ -30,14 +31,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 +54,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.