X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/fd14804d6ffb212bb88bb5560508e38b6cf432fd..84a2f117a32f0796045941260cdc4b69852b41e0:/README diff --git a/README b/README index 889a3b4..86fe988 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,25 +18,28 @@ 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) - Temperature - Uptime -- Volume percentage (OSS/ALSA) +- Volume percentage - WiFi signal percentage and ESSID 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): @@ -55,9 +58,8 @@ 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. +Upcoming +-------- -The following functions are not portable at the moment: -- wifi_{perc,essid} +A release (v1.0) will come soon... ;) +After a long phase of inactivity, development has been continued!