aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 12 insertions, 3 deletions
diff --git a/README.md b/README.md
index c3a4261..5ec6b61 100644
--- a/README.md
+++ b/README.md
@@ -154,16 +154,25 @@ takes its calendar's colour; today takes a filled pill, coloured by its own
calendar when something is on and `highlight` otherwise, with the number over
it in the heading colour because a calendar colour loses too much contrast
against the fill. Past days in the month dim: the grid is mostly about what is
-still coming. Below the grid, one row per appointment, start time left in the
-calendar's colour and title right in the body colour. Colour-coding the whole
+still coming. Below the grid, one row per appointment: date and start time
+left in the calendar's colour, title right in the body colour. The date is
+day/month with no year, since the window is a week and the grid above already
+names the month. Colour-coding the whole
row makes three calendars read as three unrelated cards, so the time carries
the code and the title stays readable. All-day events read `all day`, never
`00:00`, because midnight is a legitimate start time.
+A legend of the calendar colours is pinned along the card's bottom, in name
+order so it does not reshuffle between frames, and the event rows end above it
+rather than running under it. It lists every calendar khal declared a colour
+for, including ones with nothing on this week: it is a colour key, not a second
+list of what is coming.
+
Events come from a cache file written by `bin/calendar-sample.sh`, which shells
out to `khal`. The card shows as many rows as the cell affords and ends with
`+N more` when the week does not fit, since a card that silently drops the rest
-of the week defeats its own purpose.
+of the week defeats its own purpose. A cell too short for even one row draws
+the grid alone, without the legend, rather than a clipped half-row.
**Calendar colours come from khal's own config**, parsed out of the
`[calendars]` section by the sampler, then mapped onto the board's palette