X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/53e0c4535ac7143a871acf1d6a91dc3b0a248d87..f0070071566ad27fa36c49312e1ba3946cd472b5:/README?ds=sidebyside

diff --git a/README b/README
index 8e8803f..c0977aa 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/power/state
+- Battery percentage/state
 - CPU usage
 - CPU frequency
 - CPU iowait
@@ -31,14 +31,13 @@ Features
 
 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
-/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):
@@ -55,3 +54,14 @@ Configuration
 -------------
 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.
+
+The following functions are not portable at the moment:
+- wifi_{perc,essid}
+- cpu_{perc,iowait}
+- entropy
+- swap_{free,perc,total,used}