Commit: d79fb153c9c5533d9350637ecbf051c2af7deff9 Parent: 097fda3f32942da2f4bbf8495c9dbb6c152fef58 Author: Randy Palamar Date: Tue, 24 Dec 2024 12:47:17 -0700 update README As far as I'm aware this program no longer has any resemblance to dsblocks or slstatus besides sharing the concept of individual "blocks". Diffstat:
| M | README.md | | | 15 | ++++++++++++--- |
1 file changed, 12 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md @@ -3,9 +3,18 @@ status A status line program for dwm. -Inspired by and drawing from -[dsblocks](https://github.com/ashish-yadav11/dsblocks) and -[slstatus](https://tools.suckless.org/slstatus/). +Overview +-------- +The status line is made up of individual "blocks". Blocks update +based on a timer interval or an inotify CLOSE_WRITE notification. +Each block has an `_init()` function which is called once at startup +which facilitates the creation and initialization of any static +data and any needed registration with inotify. Afterwords a blocks +'_update()' function is called on every program tick with a `dt` +value and is expected to return with a true or false value based +on if they updated or not. Blocks being called from the inotify +event dispatcher are passed the special value `dt = 0`. This way +blocks are free to determine for themselves when they should update. Installation ------------