]> git.sur5r.net Git - i3/i3status/blob - README.md
configure.ac: complain when xmlto cannot be found
[i3/i3status] / README.md
1 # i3status 
2
3 ## Description
4
5 i3status is a small program for generating a status bar for i3bar, dzen2, xmobar
6 or similar programs. It is designed to be very efficient by issuing a very small
7 number of system calls, as one generally wants to update such a status line
8 every second. This ensures that even under high load, your status bar is updated
9 correctly. Also, it saves a bit of energy by not hogging your CPU as much as
10 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   * asciidoc (only for the documentation)
20   * libpulse-dev (for getting the current volume using PulseAudio)
21
22 On debian-based systems, the following line will install all requirements:
23 ```bash
24 apt-get install libconfuse-dev libyajl-dev libasound2-dev libiw-dev asciidoc libpulse-dev libnl-genl-3-dev
25 ```
26
27 ## Upstream
28
29 i3status is developed at https://github.com/i3/i3status
30
31 ## Compilation 
32
33 Prefer installing i3status via your Linux distribution’s package manager.
34
35 If you absolutely have to build from source, use:
36
37 ```bash
38   autoreconf -fi
39   mkdir build
40   cd build
41   ../configure
42   make -j8
43   sudo make install
44 ```