X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/7e3f80c1a39e16973f3c9235d3f9d85df0d1b995..84a2f117a32f0796045941260cdc4b69852b41e0:/README diff --git a/README b/README index ddd295b..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/power/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,20 +18,22 @@ 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 ------------ -In order to build slstatus you need the Xlib header files and optionally ALSA -for volume percentage. PulseAudio is not supported for various reasons. +Currently slstatus works on FreeBSD, Linux and OpenBSD. +In order to build slstatus you need the Xlib header files. Installation @@ -57,18 +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: -- uptime -- ipv{4,6} -- ram_{free,perc,total,used} -- wifi_{perc,essid} -- cpu_{freq,perc,iowait} -- entropy -- swap_{free,perc,total,used} -- battery_{power,state} -- temp -- vol_perc +A release (v1.0) will come soon... ;) +After a long phase of inactivity, development has been continued!