X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/ad5b7c8b1ca5e5019d6d3978045296bfbddcc349..259e106b4fbdca3df8dd660f70edf0585f14b6f6:/README diff --git a/README b/README index f14a3b8..b09fb77 100644 --- a/README +++ b/README @@ -31,14 +31,14 @@ 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). +Run ./configure first to detect your operating system. +Optionally edit config.mk to match your local setup (slstatus is installed into +the /usr/local namespace by default). Uncomment OSSLIBS on OpenBSD. Afterwards enter the following command to build and install slstatus (if necessary as root): @@ -62,13 +62,8 @@ Todo Porting to OpenBSD is the current goal before thinking about a release. The following functions are not portable at the moment: -- uptime -- ipv{4,6} -- ram_{free,perc,total,used} - wifi_{perc,essid} -- cpu_{freq,perc,iowait} +- cpu_{perc,iowait} - entropy - swap_{free,perc,total,used} -- battery_{perc,power,state} -- temp -- vol_perc +- battery_{power,state}