]> git.sur5r.net Git - i3/i3status/commitdiff
README: fix trailing whitespace, add libcap2-bin, more unicode
authorMichael Stapelberg <michael@stapelberg.de>
Tue, 10 Jul 2012 18:35:53 +0000 (20:35 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Tue, 10 Jul 2012 18:36:40 +0000 (20:36 +0200)
README

diff --git a/README b/README
index 7bd5d2ef919c331c7927fbfa1b8db69349ecee77..0cd9df99c698dafcd17009ce596b6c6d850e32da 100644 (file)
--- a/README
+++ b/README
@@ -1,36 +1,45 @@
-DESCRIPTION
-===========
-i3status is a small program (about 1500 SLOC) for generating a status bar for 
+ ┌────────────────────────────┐
+ │ 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 
+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
-===========
+ ┌────────────────────────────┐
+ │ Development                │
+ └────────────────────────────┘
+
 i3status has the following dependencies:
-- libconfuse-dev
-- libyajl-dev
-- libasound2-dev
-- libiw-dev
-- asciidoc (only for the documentation)
+ • 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
+apt-get install libconfuse-dev libyajl-dev libasound2-dev libiw-dev asciidoc libcap2-bin
+
+ ┌────────────────────────────┐
+ │ Upstream                   │
+ └────────────────────────────┘
 
-GIT-REPOSITORY
---------------
-The Code is developed at 
+i3status is developed at
   http://code.i3wm.org/i3status
-  
-You may clone the git-repository from
-  git://code.i3wm.org/i3status
 
-Talk to Michael Stapelberg for pull-requests at 
+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
-  
-COMPILING
----------
+
+ ┌────────────────────────────┐
+ │ Compilation                │
+ └────────────────────────────┘
+
 Compiling is done with the usual make-line
   make && sudo make install