Author: Aaron Marcher <firstname.lastname@example.org>
Date: Thu, 30 Jun 2016 18:29:11 +0200
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -3,6 +3,10 @@ slstatus
**slstatus** is a suckless and lightweight status monitor for window managers which use WM_NAME as statusbar (e.g. DWM). It is written in pure C without any system() calls and only reads from files most of the time. It is meant as a better alternative to Bash scripts (inefficient) and Conky (bloated for this use).
+If you write a bash script that shows system information in WM_NAME, it executes a huge amount of external command (top, free etc.) every few seconds. This results in high system resource usage. slstatus solves this problem by only using C libraries and/or reading from files in sysfs / procfs.
+Looking at the LOC (lines of code) in the [Conky project](https://github.com/brndnmtthws/conky) is very interesting: **28.346 lines C++, 219 lines Python and 110 lines Lua**. slstatus currently has about 500 lines of clean, well commented C code and even includes additional possibilities as it can be customized and extended very easily. Configuring it by editing config.h (a C header file) is very secure and fast as no config files are parsed at runtime.
The following information is included:
- battery percentage
@@ -17,7 +21,7 @@ The following information is included:
- volume percentage (alsa)
- wifi percentage
-Multiple entries per function are supported and everything can be reordered and customized via a C header file (similar to DWM).
+Multiple entries per function are supported and everything can be reordered and customized via the C header file config.h (similar to DWM).
@@ -25,7 +29,7 @@ Multiple entries per function are supported and everything can be reordered and
-Before you continue, please be sure that a C compiler, `make` and `alsa-lib` are installed. Then compile the program once using `sudo make install`. After that you may change config.h to your needs and recompile it after any change!
+Before you continue, please be sure that a C compiler, GNU make and `alsa-lib` (for volume percentage) are installed. Then copy config.def.h to config.h and edit it to your needs. Recompile and install it after every change via `sudo make install`!