Jean-Luc Makiola
03cb767f72
ROADMAP.md and STATE.md predate the issue tracker. They were how planning worked before issues and milestones existed, and keeping them means maintaining a second copy of that information by hand — which is why STATE.md still described release/v2.8.0 as the next release, eight minors ago. Issues and milestones say the same thing and can't drift: a milestone maps to its release/vX.Y.Z branch, which is now also how a contributor learns where to target a PR. Both files stay in git history if a past decision needs looking up. Repointed the six references at the tracker: the README's docs list, two rows in the docs map, PROJECT.md's Current Milestone, and REQUIREMENTS.md's idea-backlog pointer. ARCHITECTURE.md's "see the roadmap's idea backlog" now cites the crash reporter's web-issue path instead — a worked example of the no-network rule beats a pointer to a deleted backlog.
50 lines
2.1 KiB
Markdown
50 lines
2.1 KiB
Markdown
# Calendula
|
||
|
||
## What This Is
|
||
|
||
A modern Material 3 Expressive Android calendar app. Lives entirely on top
|
||
of Android's `CalendarContract` — any calendar synced to the device (CalDAV
|
||
via DAVx5, Google, local, WebCal, …) shows up automatically; creating,
|
||
editing, and deleting writes straight back, and reminders are delivered by
|
||
the app itself (Etar model). The differentiator is visual: real Material 3
|
||
Expressive design that no existing FOSS calendar app delivers.
|
||
|
||
## Core Value
|
||
|
||
A calendar app that is genuinely pleasant to look at and use, without
|
||
re-inventing the calendar sync stack — leave that to DAVx5 and the system.
|
||
|
||
## Current Milestone
|
||
|
||
Milestones 1 (read, v1.0) and 2 (write support, v1.1–v2.0.0 incl. reminder
|
||
delivery) are **complete** — v2.0.0 shipped 2026-06-11. Everything since is
|
||
tracked as issues and milestones on Codeberg:
|
||
<https://codeberg.org/jlmakiola/calendula/milestones>. A milestone maps to its
|
||
`release/vX.Y.Z` branch.
|
||
|
||
## Stack
|
||
|
||
Kotlin 2.3.21 (paired with KSP 2.3.9 — Kotlin 2.4.0 has no KSP release
|
||
yet, do not upgrade until one ships). Jetpack Compose + Material 3
|
||
Expressive 1.5.0-alpha21 (alpha is intentional — Expressive APIs only
|
||
live in the 1.5 alpha line). Hilt 2.59.2, DataStore. Gradle Kotlin DSL
|
||
with Version Catalog. AGP 9.1.1, Gradle 9.5.1. JVM target 17.
|
||
|
||
Android-only (minSdk 29, targetSdk 36). No iOS. No `INTERNET` permission —
|
||
any feature that would need one is an explicit product decision first.
|
||
|
||
## Naming
|
||
|
||
"Calendula" — Latin *kalendae* ("first day of the month", root of "calendar")
|
||
is also the etymological root of the marigold flower Calendula. The icon
|
||
shows a stylized "1" on a slate squircle.
|
||
|
||
## Source
|
||
|
||
**Codeberg (`jlmakiola/calendula`) is canonical** — git, issues, PRs, tags and
|
||
releases, plus contributor CI. The self-hosted Gitea instance is build
|
||
infrastructure only: it holds the signing key, runs the release pipeline, and
|
||
publishes the self-hosted F-Droid repo on Hetzner. Codeberg push-mirrors `main`
|
||
and tags to Gitea, where a bumped `versionName` triggers the release. Also
|
||
published to the official F-Droid repo. See `docs/RELEASING.md`.
|