Jean-Luc Makiola
b784a77329
All checks were successful
CI / ci (push) Successful in 5m34s
Add a grounded doc set under docs/ plus a root CONTRIBUTING.md: - docs/ARCHITECTURE.md: current code shape (layers, data seam, provider resolution, reminder engine, DI, build/tooling, manifest) - docs/ROADMAP.md: status view (M0/M1 done, M2 in progress, open decisions) - docs/RELEASING.md: tag-driven release flow, CI jobs, F-Droid repo, secrets (was referenced by build.gradle.kts and CHANGELOG but missing) - docs/README.md: docs index and how the docs relate - CONTRIBUTING.md: build/test/lint, layer rules, style, PR conventions Also refresh the stale "M0 — skeleton" status note in README. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
44 lines
2.1 KiB
Markdown
44 lines
2.1 KiB
Markdown
<div align="center">
|
|
|
|
<h1>Floret</h1>
|
|
|
|
<p><strong>A modern Material 3 Expressive task app for Android.</strong><br>
|
|
Reads, writes, and reminds — on top of an existing tasks provider, with no own
|
|
sync stack.</p>
|
|
|
|
<img src="https://img.shields.io/badge/Android-10%2B-3DDC84?logo=android&logoColor=white" alt="Android 10+">
|
|
<img src="https://img.shields.io/badge/Kotlin-Compose-7F52FF?logo=kotlin&logoColor=white" alt="Kotlin + Compose">
|
|
<img src="https://img.shields.io/badge/Material%203-Expressive-4285F4" alt="Material 3 Expressive">
|
|
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-green" alt="MIT License"></a>
|
|
|
|
</div>
|
|
|
|
Floret is the task-list sibling to [Calendula](https://gitea.jeanlucmakiola.de/makiolaj/calendula).
|
|
Where Calendula is a pure front-end over Android's `CalendarContract`, Floret is
|
|
a pure front-end over the **OpenTasks `TaskContract` provider** — the store that
|
|
DAVx5 (and SmoothSync, DecSync, …) syncs your CalDAV `VTODO` tasks into. No own
|
|
database, no reinvented sync.
|
|
|
|
A Calendula flower head is botanically made of many small *florets* — the
|
|
individual items that make up the bloom. Floret is those items: your tasks.
|
|
|
|
> **Status: data layer done, UI in progress.** The full non-visual stack over
|
|
> the `TaskContract` provider — provider resolution, live-updating reads,
|
|
> writes, smart-list filtering, and a self-scheduled reminder engine — is built
|
|
> and unit-tested. The Material 3 Expressive screens are now being built on top,
|
|
> one at a time. See [`docs/ROADMAP.md`](docs/ROADMAP.md) for status,
|
|
> [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) for how it's built, and
|
|
> [`docs/PLAN.md`](docs/PLAN.md) for the A-now-B-later design rationale.
|
|
|
|
## Sync sources (by design)
|
|
|
|
Floret works with anything that writes to the tasks provider — **DAVx5**
|
|
(CalDAV), **SmoothSync**, **CalDAV-Sync**, **DecSync CC**, or any Android sync
|
|
adapter — because it builds on the provider, not on any one sync app. Google
|
|
Tasks / Microsoft To Do are out of scope by design (proprietary; they would mean
|
|
owning a sync stack). Open standards — CalDAV / iCalendar / DecSync — are the lane.
|
|
|
|
## License
|
|
|
|
MIT — see [LICENSE](LICENSE).
|