git.sur5r.net Git - i3/i3status/blob - README.md

   1 # i3status
   2
   3 ## Description
   4
   5 i3status is a small program (about 1500 SLOC) for generating a status bar for
   6 i3bar, dzen2, xmobar or similar programs. It is designed to be very efficient by
   7 issuing a very small number of system calls, as one generally wants to update
   8 such a status line every second. This ensures that even under high load, your
   9 status bar is updated correctly. Also, it saves a bit of energy by not hogging
  10 your CPU as much as spawning the corresponding amount of shell commands would.
  11
  12 ## Development
  13
  14 i3status has the following dependencies:
  15   * libconfuse-dev
  16   * libyajl-dev
  17   * libasound2-dev
  18   * libnl-genl-3-dev
  19   * libcap2-bin (for getting network status without root permissions)
  20   * asciidoc (only for the documentation)
  21   * libpulse-dev (for getting the current volume using PulseAudio)
  22
  23 On debian-based systems, the following line will install all requirements:
  24 ```bash
  25 apt-get install libconfuse-dev libyajl-dev libasound2-dev libiw-dev asciidoc libcap2-bin libpulse-dev
  26 ```
  27
  28 ## Upstream
  29
  30 i3status is developed at https://github.com/i3/i3status
  31
  32 ## Complilation
  33
  34 Compiling is done with the usual make-line
  35 ```bash
  36   make && sudo make install
  37 ```