From 27b9139dfc02b76801a5a33c6eef199c822d187a Mon Sep 17 00:00:00 2001 From: Aaron Marcher Date: Sun, 20 Mar 2016 14:18:05 +0100 Subject: [PATCH] Changes to documentation and new screenshot. - Better README.md - Headlines in all files - CONTRIBUTING.md - New screenshot --- CONTRIBUTING.md | 4 ++++ CONTRIBUTORS.md | 3 ++- README.md | 37 ++++++++++++++++++++----------------- TODO.md | 3 ++- config.def.h | 14 +++++++------- screenshot.png | Bin 811 -> 939 bytes 6 files changed, 35 insertions(+), 26 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..39a704a --- /dev/null +++ b/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. diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index be36c9a..4e01b97 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,4 +1,5 @@ -# Contributors +Contributors +============ Thanks you very much for your great help! diff --git a/README.md b/README.md index 2c25f0e..a604e86 100644 --- a/README.md +++ b/README.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 @@ A suckless status monitor for DWM written in pure C without any system() calls. - 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 @@ while true; do 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. -If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style)! For indentation please use 4 spaces. +People who contributed are listed in [CONTRIBUTORS.md](CONTRIBUTORS.md). + +For detailed information about coding style and restrictions see [CONTRIBUTING.md](CONTRIBUTING.md) + +## License + +See [LICENSE.md](LICENSE.md). diff --git a/TODO.md b/TODO.md index 0bf6cb1..cfca0c0 100644 --- a/TODO.md +++ b/TODO.md @@ -1,3 +1,4 @@ -# Todo +Todo +==== - additional information for disk and memory (used, total, ...) diff --git a/config.def.h b/config.def.h index e84c40a..38af2b9 100644 --- a/config.def.h +++ b/config.def.h @@ -12,14 +12,14 @@ static const char batteryfull[] = "energy_full_design"; 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" }, diff --git a/screenshot.png b/screenshot.png index bf2468cbed185d242231e5c3f8981c87116c48fb..9b04911be5968e3f0701fce4fe9f9b0bf1a62446 100644 GIT binary patch delta 904 zcmV;319$wZ2CD}liBL{Q4GJ0x0000DNk~Le0008H0000C2nGNE0A|LeTah6$e-sT7 z8h((I7vi7RCwC$U0ZU+APBXcZ1=9l1-D=AIGL!tMRU$fews)S5EQuSS1IME z0000Opw?PSDdqF|Ko|f30KigQk{~t0A*E}@PvpGXzm4ucJ-1p;yIoQ8ZRt?;OR)#a_&4kS zE$ip>_h+(C4lfe_K6-AIect_+6>UxY%RrwZAIWpk^d<4>o4b3~p0ZBPf8qjto!46b zEPb8v*$d^RZry<>vBPa5lYJy6!~YG zOE#Wn_R}lBN6l;Y9xFb2bE4Ac@DXVfZ2+d)z`Ydf$$yl7E$xEa&SL4?x$Bb?pR)LW ziI4KKzf5a6i$7T@KZ&j_e>R|_``+|5F_)Fz&)Tj)GwifUw1ls3x7{pu-(f-f4kbbhm1Kicl8mR zAIzSnUjX2)k=70=mEPUfe=pNd9mA0yry8`P?Se|z`^Rq5d5JT&vONFYRf86@-il8%4X zCKp)mC|YC1hSw*Ee@Nsz>$CT8vN-g_=@+o`Uy(_K`$pGm{aDjF(LTKsIGikT#M~@5 zy;}O3@!#boKtNq9&-*WLsqGJ$PnMbF?JZxdpR@H#4K(^){ms(D1pNq5s3V#;zUXOMFBRzQZ?Mkx?*~_ia zZ`}Iw@c&x>xY|CoUsllCuT{ImO8Xq`VYK>9l9H0R zbe`vVo{2+J(g*2}ZYGZ7XuT>A*9u7eQS$^cug|r-6qcX#-Ysg%TY(6)hU|<(%sosC zhbJI7{vdx)o(1rKi@se&vg<<2f4;Fbvuh`Z=8>njpggnq=#GnS2RKHYS1#N+o`vOS zExi3?k4tMr>Y>SPr2aTWw&`*lo-rlT7OVrxvjG0@(zmzpmuM!BNlQQ3dW$!7cR|A>r6H*L9VHsqHb$5Dn_9^M;B2`O=q<3O)}?Im&kG7fGY3>bILe}a8t2p(i~ zI}$j9`I*-C{tT9#5pn2lC^>-OqdudO?1UB$H#hB>;dEFkavVm*>sD4DY~8EyDNx8b z(HdIo8=^ld)7=_QtKY8OvxCJ#mn6))O^Bf$gU@rF^7Iq2s7S;5cBlK8pjcoxV11w2 zHMP#IWek?HPu=A9)U;p3f1J5(lSViM@lM!sQuI(bFRe4SS<@{SU=*KLHBUEDML%2X zMN7{?{yuz=V^rc9DslLGYmWh3a}q>*2sy;Y1veOY>p3mQeBicl0fICWa@c zqN2{?qmrM)?ZA!OZx1Y(eLlb-I><)UBV4L2d=FwRvIV|ZZfWKbwxt(F~xy0FLZq3002ovPDHLk FV1nz^du9Lt