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