X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/53e0c4535ac7143a871acf1d6a91dc3b0a248d87..ee5ec756218c852385c5ba5ef0f75b47ba59ec39:/README?ds=sidebyside diff --git a/README b/README index 8e8803f..5c63c2c 100644 --- a/README +++ b/README @@ -6,10 +6,9 @@ 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) @@ -31,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): @@ -55,3 +53,12 @@ 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} +- entropy