From b79837b075305f8430859d014f892333a1b8c782 Mon Sep 17 00:00:00 2001 From: "Ali H. Fardan" Date: Tue, 23 Aug 2016 14:11:55 +0300 Subject: README update --- README.md | 43 +++++++++++++++++++++++-------------------- 1 file changed, 23 insertions(+), 20 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index e19e16d..744cea5 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,29 @@ 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). +**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. +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 **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. +Looking at the LOC (lines of code) of the [Conky project](https://github.com/brndnmtthws/conky), very interesting: *28.346 lines C++, 219 lines Python and 110 lines Lua*. slstatus currently has about **800 lines of clean documented C code** and even includes additional possibilities as it can be customized and extended very easily. Configure it by customizing the config.h (C header file) which is 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 -- uptime -- volume percentage + mute status (alsa) -- wifi signal percentage and essid +- Battery percentage +- CPU usage (in percent) +- Custom shell commands +- Date and time +- Disk[s] status (free storage, percentage, total storage and used storage) +- Available entropy +- username/gid/uid +- Hostname +- IP addresses +- Load average +- Memory status (free memory, percentage, total memory and used memory) +- Temperature +- 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). @@ -31,11 +31,14 @@ Multiple entries per function are supported and everything can be reordered and ### Installation -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`! +Before you continue, please be sure that a C compiler (preferrably gcc), GNU make and `alsa-lib` (for volume percentage) are installed. Then copy config.def.h to config.h and customize it to fit your needs. Recompile and install it after modifications: + + $ make clean all + # make install ### Starting -Put the following code in your ~/.xinitrc (or similar): +Write the following code in your ~/.xinitrc (or any other initialization script): ``` while true; do -- cgit v1.2.3 From 5b6097471ff8024029268834e482f7102d26c049 Mon Sep 17 00:00:00 2001 From: "Ali H. Fardan" Date: Tue, 23 Aug 2016 14:13:23 +0300 Subject: another update to README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 744cea5..bf435fa 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ 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). +**slstatus** is a suckless and lightweight status monitor for window managers that 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 to be 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. -- cgit v1.2.3 From ee5337babe5fb756d5877fc820a73f5a34a0d799 Mon Sep 17 00:00:00 2001 From: "Ali H. Fardan" Date: Tue, 23 Aug 2016 14:16:45 +0300 Subject: typofix && another update --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index bf435fa..c8f0896 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ slstatus **slstatus** is a suckless and lightweight status monitor for window managers that 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 to be 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. +If you write a bash script that shows system information in WM_NAME, it executes a huge amount of external commands (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) of the [Conky project](https://github.com/brndnmtthws/conky), very interesting: *28.346 lines C++, 219 lines Python and 110 lines Lua*. slstatus currently has about **800 lines of clean documented C code** and even includes additional possibilities as it can be customized and extended very easily. Configure it by customizing the config.h (C header file) which is secure and fast as no config files are parsed at runtime. @@ -40,11 +40,9 @@ Before you continue, please be sure that a C compiler (preferrably gcc), GNU mak Write the following code in your ~/.xinitrc (or any other initialization script): -``` -while true; do - slstatus -done & -``` + while true; do + slstatus + done & The loop is needed that the program runs after suspend to ram. -- cgit v1.2.3 From 674602c6af0357ed963caabbd4ae102d1ac1e77c Mon Sep 17 00:00:00 2001 From: "Ali H. Fardan" Date: Sun, 28 Aug 2016 15:33:31 +0300 Subject: grammar correction --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index c8f0896..9d6f813 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Before you continue, please be sure that a C compiler (preferrably gcc), GNU mak ### Starting -Write the following code in your ~/.xinitrc (or any other initialization script): +Write the following code to your ~/.xinitrc (or any other initialization script): while true; do slstatus -- cgit v1.2.3