X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/25bda72e646a93446ebb686cfd5252ea2d5d06a2..3cc649e34c61f557da885260d5542c805e66b0d8:/README diff --git a/README b/README index cb53544..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): @@ -60,3 +60,10 @@ 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 +- swap_{free,perc,total,used} +- battery_{power,state}