chore: 1.0.0-beta.1
The first public build. CHANGELOG's Unreleased section is rewritten as user-facing notes, since it becomes the beta's release notes. The README gains an install section, and the store short description fits Play's 80 characters.
This commit is contained in:
makiolaj committed
1 parent
e870918a03
commit
f5052f3fa9
4 files changed
+90
-253
No files matched your search
@@ -11,16 +11,20 @@ Alarms, timers, stopwatch and world clock. Open standards, no account required.<
|
||||
<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>
|
||||
|
||||
<p>
|
||||
<a href="https://apps.obtainium.imranr.dev/redirect?r=obtainium://add/https://codeberg.org/jlmakiola/clockula"><img src="https://github.com/ImranR98/Obtainium/blob/main/assets/graphics/badge_obtainium.png?raw=true" alt="Get it on Obtainium" height="56"></a>
|
||||
</p>
|
||||
|
||||
</div>
|
||||
|
||||
Clockula is the clock sibling to [Calendula](https://codeberg.org/jlmakiola/calendula)
|
||||
(calendar) and [Agendula](https://codeberg.org/jlmakiola/agendula) (tasks). The
|
||||
name follows theirs: *clock*, given Calendula's `-ula` ending. A Calendula flower
|
||||
head is botanically a cluster of many small *florets*, so the three apps are
|
||||
florets of one bloom — and they share one, [floret-kit](https://codeberg.org/jlmakiola/floret-kit).
|
||||
florets of one bloom. They also share one library, [floret-kit](https://codeberg.org/jlmakiola/floret-kit).
|
||||
|
||||
> 🚧 **Early development.** The spec is locked; the app is being built. See
|
||||
> [`docs/ROADMAP.md`](docs/ROADMAP.md) for where it actually is.
|
||||
> 🧪 **Beta.** Clockula 1.0.0 is in beta: feature-complete, and being tested
|
||||
> before the stable release. See [Install](#install) to try it.
|
||||
|
||||
## The honest difference from its siblings
|
||||
|
||||
@@ -28,31 +32,44 @@ Calendula is a pure front-end over Android's `CalendarContract`. Agendula speaks
|
||||
the dmfs `TaskContract`. Both put a good interface on a standard someone else
|
||||
already maintains.
|
||||
|
||||
**There is no open provider behind a clock.** Alarms, timers and laps are
|
||||
There is no open provider behind a clock. Alarms, timers and laps are
|
||||
Clockula's own data, so Clockula is the first app in the family to own its
|
||||
storage — by design, not as a fallback. What that commitment is replaced with is
|
||||
the first section of [`docs/PLAN.md`](docs/PLAN.md), and it comes down to three
|
||||
things:
|
||||
storage, and does so by design. The first section of
|
||||
[`docs/PLAN.md`](docs/PLAN.md) sets out what takes the place of a shared
|
||||
standard, and it comes down to three things:
|
||||
|
||||
- **Clockula speaks Android's standard alarm contract.** It implements
|
||||
- Clockula speaks Android's standard alarm contract. It implements
|
||||
`android.provider.AlarmClock` in full, so your assistant and your automation
|
||||
apps can set alarms and timers in it exactly as they would in any stock clock,
|
||||
and the system status bar and lock screen show its next alarm.
|
||||
- **World clocks are IANA time zones**, not a bespoke city list that goes stale.
|
||||
- **Your data exports** to a documented, versioned JSON file whenever you want
|
||||
- World clocks are IANA time zones, not a bespoke city list that goes stale.
|
||||
- Your data exports to a documented, versioned JSON file whenever you want
|
||||
it, because data you can't take with you isn't really yours.
|
||||
|
||||
## Alarms that actually ring
|
||||
|
||||
An alarm app is only worth having if you can trust it, so Clockula treats that as
|
||||
the feature rather than the plumbing. Alarms are scheduled as real alarm clocks —
|
||||
doze-exempt, visible to the system — and re-resolved against your current time
|
||||
An alarm app is only worth having if you can trust it, so Clockula treats reliability
|
||||
as the main feature. Alarms are scheduled as real alarm clocks (doze-exempt and
|
||||
visible to the system) and re-resolved against your current time
|
||||
zone whenever anything moves underneath them, so DST and travel don't silently
|
||||
shift them.
|
||||
|
||||
When something on your device *would* stop an alarm ringing, Clockula tells you
|
||||
which setting it is and takes you there, instead of failing quietly at 7am.
|
||||
|
||||
## Install
|
||||
|
||||
Betas are published as pre-releases on
|
||||
[Codeberg](https://codeberg.org/jlmakiola/clockula/releases), with the signed
|
||||
APK and a `.sha256` checksum attached. Download the APK there, or add
|
||||
`https://codeberg.org/jlmakiola/clockula` to
|
||||
[Obtainium](https://github.com/ImranR98/Obtainium) and switch on *Include
|
||||
prereleases* for it so it finds the beta. A beta updates in place to later betas
|
||||
and to the stable release.
|
||||
|
||||
From the stable 1.0.0 on, every release also goes to the self-hosted F-Droid
|
||||
repository that serves Calendula and Agendula.
|
||||
|
||||
## Documentation
|
||||
|
||||
Start with [`docs/`](docs/): [`PLAN.md`](docs/PLAN.md) is the spec and the
|
||||
@@ -75,4 +92,4 @@ in a (gitignored) `floret-kit/local.properties`.
|
||||
|
||||
## Licence
|
||||
|
||||
MIT — see [`LICENSE`](LICENSE).
|
||||
MIT. See [`LICENSE`](LICENSE).
|
||||
Reference in new issue
Block a user