makiolaj
c83c12cf64
The sound Google Clock and BlackyHawky's Clock use for timers is timer_expire.ogg from AOSP DeskClock, bundled with those apps rather than installed as a system ringtone, so RingtoneManager never lists it. It is now bundled here too and listed first in every sound picker. The choice is stored as clockula://tone/timer_expired and resolved to the raw resource when played, so it survives a restore into another build variant. The file is Apache-2.0, recorded in docs/PROVENANCE.md with the licence text in licenses/. Fixes #14
32 lines
1.7 KiB
Markdown
32 lines
1.7 KiB
Markdown
# Clockula — documentation
|
||
|
||
Clockula is a Material 3 Expressive **clock** app for Android: alarms, timers,
|
||
stopwatch and world clock. Third floret of the bloom, after
|
||
[Calendula](https://codeberg.org/jlmakiola/calendula) (calendar) and
|
||
[Agendula](https://codeberg.org/jlmakiola/agendula) (tasks). See the top-level
|
||
[`../README.md`](../README.md) for the pitch.
|
||
|
||
Unlike its siblings, Clockula owns its storage, because there is no open provider behind
|
||
a clock. What that costs and how the open-standards commitment is honoured anyway
|
||
is the first section of [`PLAN.md`](PLAN.md).
|
||
|
||
## Index
|
||
|
||
| Doc | What it covers |
|
||
|---|---|
|
||
| [`PLAN.md`](PLAN.md) | **The spec.** Thesis, locked decisions, the alarm engine, data model, system interop, identity, pipeline, and how ClockMaster is used. The "why". |
|
||
| [`ROADMAP.md`](ROADMAP.md) | **Status and the work queue**: milestones M0–M11 and post-v1. What the build loop works through. |
|
||
| [`ARCHITECTURE.md`](ARCHITECTURE.md) | How Clockula is built **today**: layers, the data seam, the alarm engine, DI, build/tooling, manifest. Written from M2 onward. |
|
||
| [`RELEASING.md`](RELEASING.md) | How to cut a release. Written at M0 alongside the pipeline. |
|
||
| [`PROVENANCE.md`](PROVENANCE.md) | Third-party code and assets carried in-tree, and under what licence (`PLAN.md` §11). |
|
||
|
||
Also: [`../CHANGELOG.md`](../CHANGELOG.md) (Keep a Changelog format; tag sections
|
||
feed the release notes).
|
||
|
||
## How the docs relate
|
||
|
||
- **PLAN** is the design decisions (stable; the "why").
|
||
- **ARCHITECTURE** is the current shape of the code (kept in sync as it grows).
|
||
- **ROADMAP** is the moving status layer (updated as milestones land).
|
||
- **RELEASING** is the operational runbook.
|