]> git.sur5r.net Git - i3/i3status/blobdiff - README.md
configure.ac: complain when xmlto cannot be found
[i3/i3status] / README.md
index a25fbcb9914a346fab518e6271e1b5b4b54e2c6f..d818ee6e4432f65f1aca2aa1cd6d9ea1cc54742a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,12 +2,12 @@
 
 ## 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.
+i3status is a small program 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
 
@@ -15,23 +15,30 @@ i3status has the following dependencies:
   * libconfuse-dev
   * libyajl-dev
   * libasound2-dev
-  * libiw-dev
-  * libcap2-bin (for getting network status without root permissions)
+  * libnl-genl-3-dev
   * asciidoc (only for the documentation)
   * libpulse-dev (for getting the current volume using PulseAudio)
 
 On debian-based systems, the following line will install all requirements:
 ```bash
-apt-get install libconfuse-dev libyajl-dev libasound2-dev libiw-dev asciidoc libcap2-bin libpulse-dev
+apt-get install libconfuse-dev libyajl-dev libasound2-dev libiw-dev asciidoc libpulse-dev libnl-genl-3-dev
 ```
 
 ## Upstream
 
 i3status is developed at https://github.com/i3/i3status
 
-## Complilation 
+## Compilation 
+
+Prefer installing i3status via your Linux distribution’s package manager.
+
+If you absolutely have to build from source, use:
 
-Compiling is done with the usual make-line
 ```bash
-  make && sudo make install
+  autoreconf -fi
+  mkdir build
+  cd build
+  ../configure
+  make -j8
+  sudo make install
 ```