X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/4f5ac5d9fe7525713a007727dd06d5aae031f6ac..9ac721c23fb640de2a6d1f84c84a79b2ccc26691:/README diff --git a/README b/README index 30cacd4..d55f23b 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/state +- Battery percentage/state/time left - CPU usage - CPU frequency -- CPU iowait - Custom shell commands - Date and time - Disk status (free storage, percentage, total storage and used storage) @@ -19,7 +18,9 @@ Features - IP address (IPv4 and IPv6) - Kernel version - Keyboard indicators +- Keymap - Load average +- Network speeds (RX and TX) - Number of files in a directory (hint: Maildir) - Memory status (free memory, percentage, total memory and used memory) - Swap status (free swap, percentage, total swap and used swap) @@ -31,13 +32,14 @@ Features Requirements ------------ +Currently slstatus works on FreeBSD, Linux and OpenBSD. 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). Uncomment OSSLIBS on OpenBSD. +/usr/local namespace by default). Afterwards enter the following command to build and install slstatus (if necessary as root): @@ -58,11 +60,4 @@ 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} +Cleaning up the whole codebase it the goal before thinking about a release.