X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/779f611208ea8ee7475df7729451f33104e1369a..97ef7c2a1d67bb2c9c379e657fbc8e35acd6aafb:/README diff --git a/README b/README index 0dde336..80edd50 100644 --- a/README +++ b/README @@ -9,13 +9,14 @@ Features - Battery percentage/power/state - CPU usage - CPU frequency +- CPU iowait - Custom shell commands - Date and time - Disk status (free storage, percentage, total storage and used storage) - Available entropy - Username/GID/UID - Hostname -- IP address +- IP address (IPv4 and IPv6) - Kernel version - Keyboard indicators - Load average @@ -30,8 +31,7 @@ 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 @@ -54,3 +54,18 @@ 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: +- ipv{4,6} +- wifi_{perc,essid} +- cpu_{freq,perc,iowait} +- entropy +- swap_{free,perc,total,used} +- battery_{power,state} +- temp +- vol_perc