X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/66a7fb16fc903ac7ef6ce1acdbb353f1072cd0ec..2b0f50d1aaf22e79272df8b3b0fe37f338ea1dae:/README diff --git a/README b/README index 5c63c2c..d55f23b 100644 --- a/README +++ b/README @@ -6,7 +6,7 @@ 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 - Custom shell commands @@ -18,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) @@ -30,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): @@ -57,8 +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} -- entropy +Cleaning up the whole codebase it the goal before thinking about a release.