X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/8f5219b6dab5a1c9b7f92362a34aacfd393fa0e4..efb41724b5499bf61ab65ff65908d686e59ecdc0:/README diff --git a/README b/README index 19f422e..0961030 100644 --- a/README +++ b/README @@ -6,9 +6,10 @@ 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 +- CPU iowait - Custom shell commands - Date and time - Disk status (free storage, percentage, total storage and used storage) @@ -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,13 @@ 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 +---- +Porting to OpenBSD is the current goal before thinking about a release. + +The following functions are not portable at the moment: +- wifi_{perc,essid} +- cpu_{perc,iowait} +- entropy