README.md
1# i3status
2
3## Description
4
5i3status is a small program for generating a status bar for i3bar, dzen2, xmobar
6or similar programs. It is designed to be very efficient by issuing a very small
7number of system calls, as one generally wants to update such a status line
8every second. This ensures that even under high load, your status bar is updated
9correctly. Also, it saves a bit of energy by not hogging your CPU as much as
10spawning the corresponding amount of shell commands would.
11
12## Development
13
14i3status has the following dependencies:
15 * libconfuse-dev
16 * libyajl-dev
17 * libasound2-dev
18 * libnl-genl-3-dev
19 * meson (compile-time only dependency)
20 * asciidoc (only for the documentation)
21 * libpulse-dev (for getting the current volume using PulseAudio)
22
23On debian-based systems, the following line will install all requirements:
24```bash
25apt-get install autoconf libconfuse-dev libyajl-dev libasound2-dev libiw-dev asciidoc libpulse-dev libnl-genl-3-dev meson
26```
27
28## Upstream
29
30i3status is developed at https://github.com/i3/i3status
31
32## Compilation
33
34Prefer installing i3status via your Linux distribution’s package manager.
35
36If you absolutely have to build from source, use:
37
38```bash
39 mkdir build
40 cd build
41 meson ..
42 ninja
43 sudo ninja install
44```
45