diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 37 |
1 files changed, 20 insertions, 17 deletions
@@ -1,8 +1,9 @@ -# slstatus +slstatus +======== -A suckless status monitor for DWM written in pure C without any system() calls. +**slstatus** is a suckless and lightweight status monitor for window managers which use WM_NAME as statusbar (e.g. DWM). It is written in pure C without any system() calls and only reads from files most of the time. It is meant as a better alternative to Bash scripts (inefficient) and Conky (bloated for this use). -# Information included +The following information is included: - wifi percentage - battery percentage @@ -14,23 +15,19 @@ A suckless status monitor for DWM written in pure C without any system() calls. - date - time -Multiple batteries, wifi cards etc. are supported and everything can be reordered and customized via a C header file (similar to DWM). - -# Screenshot +Multiple entries (battery, wifi signal, ...) are supported and everything can be reordered and customized via a C header file (similar to DWM).  -# Installation - -Just run ```sudo make install```! :P +## Usage -# Configuration +### Installation -Just change config.h (commented) to your needs and recompile! +Before you continue, please be sure that a C compiler, `make` and `alsa-lib` are installed. Then compile the program once using `sudo make install`. After that you may change config.h to your needs and recompile it after any change! -# Starting +### Starting -Put the following code in your ~/.xinitrc: +Put the following code in your ~/.xinitrc (or similar): ``` while true; do @@ -38,10 +35,16 @@ while true; do done & ``` -# Contributing +The loop is needed that the program runs after suspend to ram. + +## Contributing + +In [TODO.md](TODO.md) there is a list of things that have to be done. + +People who contributed are listed in [CONTRIBUTORS.md](CONTRIBUTORS.md). -See TODO.md for things that you could do. +For detailed information about coding style and restrictions see [CONTRIBUTING.md](CONTRIBUTING.md) -People who contributed are listed in the CONTRIBUTORS.md file. +## License -If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style)! For indentation please use 4 spaces. +See [LICENSE.md](LICENSE.md). |