README.md

   1 slstatus
   2 ========
   3
   4 **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).
   5
   6 The following information is included:
   7
   8 - wifi percentage
   9 - battery percentage
  10 - cpu usage in percent
  11 - cpu temperature
  12 - ram usage in percent
  13 - alsa volume level in percent
  14 - disk usage
  15 - date
  16 - time
  17
  18 Multiple entries (battery, wifi signal, ...) are supported and everything can be reordered and customized via a C header file (similar to DWM).
  19
  20 ![screenshot](screenshot.png)
  21
  22 ## Usage
  23
  24 ### Installation
  25
  26 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!
  27
  28 ### Starting
  29
  30 Put the following code in your ~/.xinitrc (or similar):
  31
  32 ```
  33 while true; do
  34     slstatus
  35 done &
  36 ```
  37
  38 The loop is needed that the program runs after suspend to ram.
  39
  40 ## Contributing
  41
  42 In [TODO.md](TODO.md) there is a list of things that have to be done.
  43
  44 People who contributed are listed in [CONTRIBUTORS.md](CONTRIBUTORS.md).
  45
  46 For detailed information about coding style and restrictions see [CONTRIBUTING.md](CONTRIBUTING.md)
  47
  48 ## License
  49
  50 See [LICENSE](LICENSE).