all repos — slstatus @ 27b9139dfc02b76801a5a33c6eef199c822d187a

my build of slstatus (tools.suckless.org/slstatus/)

Changes to documentation and new screenshot.

- Better README.md
- Headlines in all files
- CONTRIBUTING.md
- New screenshot
Aaron Marcher info@nulltime.net
Sun, 20 Mar 2016 14:18:05 +0100
commit

27b9139dfc02b76801a5a33c6eef199c822d187a

parent

02af858a35d225f25de260accec19fa71587d7f2

6 files changed, 35 insertions(+), 26 deletions(-)

jump to
A CONTRIBUTING.md

@@ -0,0 +1,4 @@

+Contributing +============ + +If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style) and 4 spaces for indentation.
M CONTRIBUTORS.mdCONTRIBUTORS.md

@@ -1,4 +1,5 @@

-# Contributors +Contributors +============ Thanks you very much for your great help!
M README.mdREADME.md

@@ -1,8 +1,9 @@

-# slstatus +slstatus +======== -A suckless status monitor for DWM written in pure C without any system() calls. +**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). -# Information included +The following information is included: - wifi percentage - battery percentage

@@ -14,23 +15,19 @@ - disk usage

- date - time -Multiple batteries, wifi cards etc. are supported and everything can be reordered and customized via a C header file (similar to DWM). - -# Screenshot +Multiple entries (battery, wifi signal, ...) are supported and everything can be reordered and customized via a C header file (similar to DWM). ![screenshot](screenshot.png) -# Installation +## Usage -Just run ```sudo make install```! :P +### Installation -# Configuration +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! -Just change config.h (commented) to your needs and recompile! +### Starting -# Starting - -Put the following code in your ~/.xinitrc: +Put the following code in your ~/.xinitrc (or similar): ``` while true; do

@@ -38,10 +35,16 @@ slstatus

done & ``` -# Contributing +The loop is needed that the program runs after suspend to ram. -See TODO.md for things that you could do. +## Contributing -People who contributed are listed in the CONTRIBUTORS.md file. +In [TODO.md](TODO.md) there is a list of things that have to be done. + +People who contributed are listed in [CONTRIBUTORS.md](CONTRIBUTORS.md). + +For detailed information about coding style and restrictions see [CONTRIBUTING.md](CONTRIBUTING.md) -If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style)! For indentation please use 4 spaces. +## License + +See [LICENSE.md](LICENSE.md).
M TODO.mdTODO.md

@@ -1,3 +1,4 @@

-# Todo +Todo +==== - additional information for disk and memory (used, total, ...)
M config.def.hconfig.def.h

@@ -12,14 +12,14 @@ /* bar update interval in seconds (smallest value = 1) */

static unsigned int update_interval = 1; /* statusbar -- get_battery (battery percentage) [argument: battery name] -- cpu_temperature (cpu temperature in degrees) [argument: temperature file] -- cpu usage (cpu usage in percent) +- battery_perc (battery percentage) [argument: battery name] +- cpu_perc (cpu usage in percent) [argument: NULL] - datetime (date and time) [argument: format] -- diskusage (disk usage in percent) [argument: mountpoint] -- ram_usage (ram usage in percent) -- volume (alsa volume and mute status in percent) [argument: soundcard] -- wifi_signal (wifi signal in percent) [argument: wifi card interface name] */ +- disk_perc (disk usage in percent) [argument: mountpoint] +- ram_perc (ram usage in percent) [argument: NULL] +- temp (temperature in degrees) [argument: temperature file] +- vol_perc (alsa volume and mute status in percent) [argument: soundcard] +- wifi_perc (wifi signal in percent) [argument: wifi card interface name] */ static const struct arg args[] = { /* function format argument */ { wifi_perc, "wifi %4s | ", "wlp3s0" },