diff options
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | CONTRIBUTORS.md | 3 | ||||
| -rw-r--r-- | README.md | 37 | ||||
| -rw-r--r-- | TODO.md | 3 | ||||
| -rw-r--r-- | config.def.h | 14 | ||||
| -rw-r--r-- | screenshot.png | bin | 811 -> 939 bytes |
6 files changed, 35 insertions, 26 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..39a704a --- /dev/null +++ b/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. diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index be36c9a..4e01b97 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,4 +1,5 @@ -# Contributors +Contributors +============ Thanks you very much for your great help! @@ -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). @@ -1,3 +1,4 @@ -# Todo +Todo +==== - additional information for disk and memory (used, total, ...) diff --git a/config.def.h b/config.def.h index e84c40a..38af2b9 100644 --- a/config.def.h +++ b/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] -- cpu_temperature (cpu temperature in degrees) [argument: temperature file] -- cpu usage (cpu usage in percent) +- battery_perc (battery percentage) [argument: battery name] +- cpu_perc (cpu usage in percent) [argument: NULL] - datetime (date and time) [argument: format] -- diskusage (disk usage in percent) [argument: mountpoint] -- ram_usage (ram usage in percent) -- volume (alsa volume and mute status in percent) [argument: soundcard] -- wifi_signal (wifi signal in percent) [argument: wifi card interface name] */ +- disk_perc (disk usage in percent) [argument: mountpoint] +- ram_perc (ram usage in percent) [argument: NULL] +- temp (temperature in degrees) [argument: temperature file] +- 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" }, diff --git a/screenshot.png b/screenshot.png Binary files differindex bf2468c..9b04911 100644 --- a/screenshot.png +++ b/screenshot.png |
