diff --git a/blinkenlicht/README.md b/blinkenlicht/README.md index c3e4d29..b16e891 100644 --- a/blinkenlicht/README.md +++ b/blinkenlicht/README.md @@ -8,6 +8,26 @@ More seriously: you might prefer this over another status bar program if you want fine-grained control over what is shown in your bar and you are happy to exert that control in a Lua-based Lisp language. +## Current status and usage + +Not quite dogfood-ready yet, but fast approaching. + +* bl.fnl is an example + +* blinkenlicht.fnl is the module that parses `bar` and `indicator` + forms and does all the UI + +* also in bl.fnl but needs extracting to a home of its own, all the + glue that looks up load average, wifi signal strength, time of day + etc for indicators to use + +Use the `default.nix` for guidance as to libraries and other setup +required - or just use it, of course. + + nix-shell + lua $fennel bl.fnl + + ## Plan * [X] use gtk-layer-shell to put it in a layer @@ -15,8 +35,14 @@ you are happy to exert that control in a Lua-based Lisp language. * [X] cache icon pixbufs * [] update image/label widget instead of destroying * [] allow height customisation +* [] add some mechanism for indicators that wait for events instead of polling +* [] set poll interval based on indicators' requested intervals +* [] set indicator background colour (use css for this?) ```fennel + +;; your status bar specification might look something like this + (bar { :anchor [:top :right]