X-Git-Url: https://git.xinqibao.xyz/slstatus.git/blobdiff_plain/2b8e20472378217bef7f8601cd2fc1dfee02559c..f9f72a06f11de9ecd1b14811eba63c6e8c7a1165:/README.md?ds=sidebyside diff --git a/README.md b/README.md index 51db398..e19e16d 100644 --- a/README.md +++ b/README.md @@ -5,26 +5,28 @@ slstatus 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. +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 **600 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 - cpu usage (in percent) +- custom shell commands - date and time - disk numbers (free storage, percentage, total storage and used storage) - available entropy +- username/gid/uid of current user - hostname - ip addresses +- load average - ram numbers (free ram, percentage, total ram and used ram) - temperature -- volume percentage (alsa) -- wifi percentage +- uptime +- volume percentage + mute status (alsa) +- wifi signal percentage and essid Multiple entries per function are supported and everything can be reordered and customized via the C header file config.h (similar to DWM). -![screenshot](screenshot.png) - ## Usage ### Installation @@ -37,7 +39,7 @@ Put the following code in your ~/.xinitrc (or similar): ``` while true; do - slstatus + slstatus done & ```