summaryrefslogtreecommitdiff
path: root/README
blob: 0cd9df99c698dafcd17009ce596b6c6d850e32da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 ┌────────────────────────────┐
 │ Description                │
 └────────────────────────────┘

i3status is a small program (about 1500 SLOC) for generating a status bar for
i3bar, dzen2, xmobar or similar programs. It is designed to be very efficient by
issuing a very small number of system calls, as one generally wants to update
such a status line every second. This ensures that even under high load, your
status bar is updated correctly. Also, it saves a bit of energy by not hogging
your CPU as much as spawning the corresponding amount of shell commands would.

 ┌────────────────────────────┐
 │ Development                │
 └────────────────────────────┘

i3status has the following dependencies:
 • libconfuse-dev
 • libyajl-dev
 • libasound2-dev
 • libiw-dev
 • libcap2-bin (for getting network status without root permissions)
 • asciidoc (only for the documentation)

On debian-based systems, the following line will install all requirements:
apt-get install libconfuse-dev libyajl-dev libasound2-dev libiw-dev asciidoc libcap2-bin

 ┌────────────────────────────┐
 │ Upstream                   │
 └────────────────────────────┘

i3status is developed at
  http://code.i3wm.org/i3status

You may clone the git-repository using
  git clone git://code.i3wm.org/i3status

Talk to Michael Stapelberg for pull-requests at
  michael+i3status@stapelberg.de

 ┌────────────────────────────┐
 │ Compilation                │
 └────────────────────────────┘

Compiling is done with the usual make-line
  make && sudo make install