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 zcmZ3@wwhhBGr-TCmrII^fq{Y7)59f*fq`i!0|NsO2O9$eL)x*W(GwMo>P2`3r6=nb zO=VzUw(xXu45_&FHa5EGr~=23kYHe7I1m&wNx_Uep}z5*=8eE(?ySlDc1udu{`fd0fA#fwdDY+F z&z^s^=vF23OU?Te*J%Ed-&=3?@9nR8``W)L77Uf=?I+h3RW7`7Uv{l++Q##Oy%+Bt zG5(jj;QZ8$+xfQcdUj;F{JGHV(!KJfl^+$CW*_x`vgg+R-gox4+oSw;#|D1NeHrl8 zdn5a)ALg(B>%M;e<$L-je?EPo|8`Y*Q)}=2ohF*=`{%U7d?opl#TUP*etbE5clEV- zoBYnzKVqt#dp+v^Q@)?ir>!sfGnb#?HG4yCTF2`M=3{H=8k zPeY@fG#cM>2}P!5giB0aqjM@S)p4h0&^0N`h-pt&sGi#7Xx+EO#w<(x!?peGb>Zve zwdbF@$ol;6>f4z%k5(9l`~Ky3 zr>OXHt19k#|Hut@PdnA`zO}Qx$I_(ytKb~@GxL_kGdx%~@fx4z)O&ZY)$3pOmpwdD ze!0|^MQ@wDuKzxscd4>p%kuhcF@x(BM!8kSAIz)whp%MpC~R0Rn^YDZznV$r`GoAB zU-?u7k9oF)?c4m@V$M%>8(YEXA9rYehtY2^b zUa-mH%aNDj8$QQR^lbUczpGa3Z+gCY|9+OgPfBRU zG2iQJVq9momp)tTK0V4Wdw%y8My`6XPjUTa49d0@U*39c=DvA)?S=e1zdn8VAN7C7 zExWDpVHa+#58Zvl>$l9?#4W#iGt?zt-k7zoy)UfpVW!Ib^-cA!xfxFQF@jQm;ty6E YpOsEWLoCiPFfcH9y85}Sb4q9e00Sb)F#rGn delta 775 zcmZ3@zM4(3Gr-TCmrII^fq{Y7)59f*fq^NDfq{XCgNcEGA-0LlZK9%4Jr}2pg|X(> zTMP_LJ3L(+Ln>~)jfvgVs=)DXUgqw#%Xsgzr_Wg?Fwy?xgO$l$KRP)w(r-_iG-*f4 zyyunkI-P?qvA^ukQ|o)2u~&=#I+w@az|Sm3>(6i9BQkCNmwUQdr=lA+boR((j$^@@nD9+$H}kT(-R|l9^|ydP!^z^Qp}Y|K4BPzWu}W47GkwZ~L27 z-R32a7hA8(%Ue0+e@Bm-dG5|^vnSJKj|a9z$=#Fo;M6Rf@YrE}{ae+-e@1+Hay$~{ z=jxkklQ`s3O00z}nt#r`_U#|fw7G(XFY+`j8y+mSTRiDaix{7|`P-QfOCq$2WZaIv z4hxgdxx4y!NSqhGsvpLhIcS2H0w)x;%;sMilF5}%< zYMFih$E?iDhaO(7pTB_Riu2l|>qM>AKXg0&_twR1)y-cVUq@}aYxC}Qk;&61rCqJB zsytsmJP`5FMP`Ec=fv&P0zUpN|Ds!=)~3FE(V}yY7EhXg`0at-+xat9Yxn*WH#qpZ zr&F3QvGCd<#s8v-yY@ZheZJ(~s+9Wa`hv;(wK7h3uaPgk`2PKgyECtSjXlI`%f4={ zPMDMif1c60{8Cq^4~9n@jr2=u9zAaOJpH=)p@*dwt6wi%_xI(x?Dk4_-!0SXjGlx~ rJl@p*d5?;!u5_E4s;X+_1^X|po3itsPT9u5z`)??>gTe~DWM4f>(qN@