X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/2b82bf02488147a3e69a715267934f015fe29a43..refs/heads/master:/README diff --git a/README b/README index 805f541..86fe988 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,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): @@ -56,11 +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} -- cpu_iowait -- entropy +A release (v1.0) will come soon... ;) +After a long phase of inactivity, development has been continued!