aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-09-17 13:25:13 +0200
committerDanilo M. <danix@danix.xyz>2026-09-17 13:25:13 +0200
commit856abdc38495bbe304b690a98fa89491a1a6fce6 (patch)
tree374b57ffe9d3de8f9ae2d80d4d3760b543ba91b4 /README.md
parent8e1baa72813fd93fc103b6d2d69753f952a24e3f (diff)
downloadconky-theme-udt-856abdc38495bbe304b690a98fa89491a1a6fce6.tar.gz
conky-theme-udt-856abdc38495bbe304b690a98fa89491a1a6fce6.zip
docs: record the visual identity in DESIGN.md
DESIGN.md states the two rules that carry the board's identity (big value at the card's top-right, rows label-left/value-right), plus the type, colour and glyph conventions, with AGENTS.md pointing at it for anyone adding a widget.
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 71efc9e..ba3e260 100644
--- a/README.md
+++ b/README.md
@@ -153,6 +153,8 @@ grid or the screen changes.
## Writing a widget
+`DESIGN.md` is the visual identity every card follows; read it first.
+
A widget module exports one function, `draw(cr, rect, colors)`. `lib/card.lua`
carries the primitives it should use rather than reaching for Cairo directly: