disk usage in README.md

[slstatus.git] / README.md

diff --git a/README.md b/README.md
index ce55737..2c25f0e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
 # slstatus
 # slstatus

+

 A suckless status monitor for DWM written in pure C without any system() calls.
 
 A suckless status monitor for DWM written in pure C without any system() calls.
 

-# information
+# Information included

 
 - wifi percentage
 - battery percentage
 
 - wifi percentage
 - battery percentage


@@ -9,9 +10,38 @@ A suckless status monitor for DWM written in pure C without any system() calls.
 - cpu temperature
 - ram usage in percent
 - alsa volume level in percent
 - cpu temperature
 - ram usage in percent
 - alsa volume level in percent

+- disk usage

 - date
 - time
 
 - date
 - time
 

-# configuration
+Multiple batteries, wifi cards etc. are supported and everything can be reordered and customized via a C header file (similar to DWM).
+
+# Screenshot
+
+![screenshot](screenshot.png)
+
+# Installation
+
+Just run ```sudo make install```! :P
+
+# Configuration
+
+Just change config.h (commented) to your needs and recompile!
+
+# Starting
+
+Put the following code in your ~/.xinitrc:
+
+```
+while true; do
+    slstatus
+done &
+```
+
+# Contributing
+
+See TODO.md for things that you could do.
+
+People who contributed are listed in the CONTRIBUTORS.md file.

 
 

-Just edit config.h and recompile!
+If you want to contribute, please use [the suckless coding style](http://suckless.org/coding_style)! For indentation please use 4 spaces.