X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/53e0c4535ac7143a871acf1d6a91dc3b0a248d87..5db729fedbc4b6cb8742c58ff4934afb50732974:/README diff --git a/README b/README index 8e8803f..4f23959 100644 --- a/README +++ b/README @@ -6,10 +6,10 @@ slstatus is a suckless status monitor for window managers that use WM_NAME Features -------- -- Battery percentage/power/state +- Backlight percentage +- Battery percentage/state/time left - CPU usage - CPU frequency -- CPU iowait - Custom shell commands - Date and time - Disk status (free storage, percentage, total storage and used storage) @@ -19,7 +19,9 @@ Features - IP address (IPv4 and IPv6) - Kernel version - Keyboard indicators +- Keymap - 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) @@ -31,14 +33,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): @@ -55,3 +56,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.