lucic71
/
i3status
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

adding new markdown README.md to display nicely on github

This commit is contained in:
konadr 2015-09-23 22:01:09 +01:00
parent fb57fca5c2
commit b61665ab94
2 changed files with 37 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README
View File

@ -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

37
README.md Normal file
View File

@ -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
```