Add FreeBSD support for temperature and battery components

[slstatus.git] / README

diff --git a/README b/README
index 0eac61a..233e252 100644 (file)
--- a/README
+++ b/README
@@ -6,10 +6,9 @@ slstatus is a suckless status monitor for window managers that use WM_NAME
 
 Features
 --------
 
 Features
 --------

-- Battery percentage/power/state
+- Battery percentage/state/time left

 - CPU usage
 - CPU frequency
 - CPU usage
 - CPU frequency

-- CPU iowait

 - Custom shell commands
 - Date and time
 - Disk status (free storage, percentage, total storage and used storage)
 - 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
 - IP address (IPv4 and IPv6)
 - Kernel version
 - Keyboard indicators

+- Keymap

 - Load average
 - 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)
 - 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,14 +32,13 @@ Features
 
 Requirements
 ------------
 
 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.
+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
 
 
 Installation
 ------------
 Edit config.mk to match your local setup (slstatus is installed into the

-/usr/local namespace by default).
+/usr/local namespace by default). Uncomment OSSLIBS on OpenBSD.

 
 Afterwards enter the following command to build and install slstatus (if
 necessary as root):
 
 Afterwards enter the following command to build and install slstatus (if
 necessary as root):


@@ -59,15 +59,4 @@ source code. This keeps it fast, secure and simple.
 
 Todo
 ----
 
 Todo
 ----

-Porting to OpenBSD is the current goal before thinking about a release.
-
-The following functions are not portable at the moment:
-- 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
+Cleaning up the whole codebase it the goal before thinking about a release.