Changes to documentation and new screenshot.

- Better README.md
- Headlines in all files
- CONTRIBUTING.md
- New screenshot

CONTRIBUTING.md

@@ -0,0 +1,4 @@
+Contributing
+============
+
+If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style) and 4 spaces for indentation.

CONTRIBUTORS.md

@@ -1,4 +1,5 @@
-# Contributors
+Contributors
+============
 
 Thanks you very much for your great help!
 

README.md

@@ -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).
+Multiple entries (battery, wifi signal, ...) are supported and everything can be reordered and customized via a C header file (similar to DWM).
-
-# Screenshot
 
 ![screenshot](screenshot.png)
 
-# Installation
+## Usage
 
-Just run ```sudo make install```! :P
+### Installation
 
-# Configuration
+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! 
 
-Just change config.h (commented) to your needs and recompile!
+### Starting
 
-# Starting
+Put the following code in your ~/.xinitrc (or similar):
-
-Put the following code in your ~/.xinitrc:
 
 ```
 while true; do
@@ -38,10 +35,16 @@ while true; do
 done &
 ```
 
-# Contributing
+The loop is needed that the program runs after suspend to ram.
 
-See TODO.md for things that you could do.
+## Contributing
 
-People who contributed are listed in the CONTRIBUTORS.md file.
+In [TODO.md](TODO.md) there is a list of things that have to be done.
 
-If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style)! For indentation please use 4 spaces.
+People who contributed are listed in [CONTRIBUTORS.md](CONTRIBUTORS.md).
+
+For detailed information about coding style and restrictions see [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## License
+
+See [LICENSE.md](LICENSE.md).

TODO.md

@@ -1,3 +1,4 @@
-# Todo
+Todo
+====
 
 - additional information for disk and memory (used, total, ...)

config.def.h

@@ -12,14 +12,14 @@ static const char batteryfull[] = "energy_full_design";
 static unsigned int update_interval = 1;
 
 /* statusbar
-- get_battery (battery percentage) [argument: battery name]
+- battery_perc (battery percentage) [argument: battery name]
-- cpu_temperature (cpu temperature in degrees) [argument: temperature file]
+- cpu_perc (cpu usage in percent) [argument: NULL]
-- cpu usage (cpu usage in percent)
 - datetime (date and time) [argument: format]
-- diskusage (disk usage in percent) [argument: mountpoint]
+- disk_perc (disk usage in percent) [argument: mountpoint]
-- ram_usage (ram usage in percent)
+- ram_perc (ram usage in percent) [argument: NULL]
-- volume (alsa volume and mute status in percent) [argument: soundcard]
+- temp (temperature in degrees) [argument: temperature file]
-- wifi_signal (wifi signal in percent) [argument: wifi card interface name] */
+- vol_perc (alsa volume and mute status in percent) [argument: soundcard]
+- wifi_perc (wifi signal in percent) [argument: wifi card interface name] */
 static const struct arg args[] = {
     /* function     format          argument */
     { wifi_perc,    "wifi %4s | ",  "wlp3s0" },