README.md

   1 # slstatus
   2
   3 A suckless status monitor for DWM written in pure C without any system() calls.
   4
   5 # Information included
   6
   7 - wifi percentage
   8 - battery percentage
   9 - cpu usage in percent
  10 - cpu temperature
  11 - ram usage in percent
  12 - alsa volume level in percent
  13 - disk usage
  14 - date
  15 - time
  16
  17 Multiple batteries, wifi cards etc. are supported and everything can be reordered and customized via a C header file (similar to DWM).
  18
  19 # Screenshot
  20
  21 ![screenshot](screenshot.png)
  22
  23 # Installation
  24
  25 Just run ```sudo make install```! :P
  26
  27 # Configuration
  28
  29 Just change config.h (commented) to your needs and recompile!
  30
  31 # Starting
  32
  33 Put the following code in your ~/.xinitrc:
  34
  35 ```
  36 while true; do
  37     slstatus
  38 done &
  39 ```
  40
  41 # Contributing
  42
  43 See TODO.md for things that you could do.
  44
  45 People who contributed are listed in the CONTRIBUTORS.md file.
  46
  47 If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style)! For indentation please use 4 spaces.