From: konadr <brioscaibriste@gmail.com>
Date: Wed, 23 Sep 2015 21:01:09 +0000 (+0100)
Subject: adding new markdown README.md to display nicely on github
X-Git-Tag: 2.10~18^2
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=b61665ab94175f2d7047519d85f874358016e783;p=i3%2Fi3status

adding new markdown README.md to display nicely on github
---

diff --git a/README b/README
deleted file mode 100644
index de61faf..0000000
--- a/README
+++ /dev/null
@@ -1,40 +0,0 @@
- ┌────────────────────────────┐
- │ 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)
- • libpulse-dev (for getting the current volume using PulseAudio)
-
-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 libpulse-dev
-
- ┌────────────────────────────┐
- │ Upstream                   │
- └────────────────────────────┘
-
-i3status is developed at
-  https://github.com/i3/i3status
-
- ┌────────────────────────────┐
- │ Compilation                │
- └────────────────────────────┘
-
-Compiling is done with the usual make-line
-  make && sudo make install
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a25fbcb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# i3status 
+
+## 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)
+  * 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
+```
+
+## Upstream
+
+i3status is developed at https://github.com/i3/i3status
+
+## Complilation 
+
+Compiling is done with the usual make-line
+```bash
+  make && sudo make install
+```