From 9febe294706d346ca49e7e63c8b3a464466728f4 Mon Sep 17 00:00:00 2001 From: onelin Date: Fri, 1 May 2026 19:38:40 +0200 Subject: Add readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..c3109a8 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Statusbar script + +This is a small set of C files that writes the current ethernet status, battery +level and date in "%F %R" format to standard out. + +## Compiling + +To compile the status and controller programs, run +``` +cc -g -lrt status.c -o status +cc -g -lrt status_update.c -o status_ctl +``` + + +## Usage + +Run the status script as part of your WM init, my fork of dwl reads status from +stdin, so I run `dwl` like `./status | dwl`. + +To manually update an element, run `./status_ctl update `. ELEMENT can +be one of the elements defined in `config.def.h`, or `all` to update every +element. + +You modify `config.def.h` to change which elements and in which the order +they're shown, as well as how often they're automatically updated. + + +The `status_ctl` script is neat to update elements on events, eg. when you +connect to wifi or change the volume or brightness of your monitor. -- cgit v1.3