X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/779f611208ea8ee7475df7729451f33104e1369a..3cc649e34c61f557da885260d5542c805e66b0d8:/README

diff --git a/README b/README
index 0dde336..b09fb77 100644
--- a/README
+++ b/README
@@ -9,13 +9,14 @@ Features
 - Battery percentage/power/state
 - CPU usage
 - CPU frequency
+- CPU iowait
 - Custom shell commands
 - Date and time
 - Disk status (free storage, percentage, total storage and used storage)
 - Available entropy
 - Username/GID/UID
 - Hostname
-- IP address
+- IP address (IPv4 and IPv6)
 - Kernel version
 - Keyboard indicators
 - Load average
@@ -30,14 +31,14 @@ 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).
+Run ./configure first to detect your operating system.
+Optionally edit config.mk to match your local setup (slstatus is installed into
+the /usr/local namespace by default). Uncomment OSSLIBS on OpenBSD.
 
 Afterwards enter the following command to build and install slstatus (if
 necessary as root):
@@ -54,3 +55,15 @@ 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}
+- battery_{power,state}