Xinqi Bao's Git
projects
/
slstatus.git
/ blobdiff
summary
|
log
|
commit
|
diff
|
tree
raw
|
inline
| side by side
Update README todo
[slstatus.git]
/
README
diff --git
a/README
b/README
index
77659b4
..
c0977aa
100644
(file)
--- a/
README
+++ b/
README
@@
-6,16
+6,17
@@
slstatus is a suckless status monitor for window managers that use WM_NAME
Features
--------
Features
--------
-- Battery percentage/
power/
state
+- Battery percentage/state
- 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)
- Available entropy
- Username/GID/UID
- Hostname
- 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
- Kernel version
- Keyboard indicators
- Load average
@@
-30,17
+31,16
@@
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
dmenu (if necessary
-as root):
+Afterwards enter the following command to build and install
slstatus (if
+
necessary
as root):
make clean install
make clean install
@@
-54,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.
-------------
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}