README, AGENTS.md: a short README for people, the detail in AGENTS.md
The README had grown to 422 lines: the device and carrier table came after 61 lines of architecture, and the configuration section after 237 lines of architecture, that table, build, run and packaging notes and GNOME Calls detail. AGENTS.md, a file for coding agents, takes that detail and adds to it: a reference to the tree at this commit, written from the code and the bench record. The README is now what a person needs: what imsd is and its status, the verified device/carrier table, what it needs, how to install and enable it, the two dialers, a status check for the installed daemon, a `Not there yet` list, and where the rest is. In-tree comments that sent readers to README sections which moved — the cross-compiling flow (the CI workflow, build-package.sh, APKBUILD.binary), GNOME Calls' known gaps (imsd-ofono-restart-calls.sh), the D-Bus ABI (main.cpp) and the Configuration section (imsd.service) — point at AGENTS.md's sections now.
This commit is contained in:
parent
f18baf2790
commit
828b0af95b
8 changed files with 1113 additions and 371 deletions
|
|
@ -2,7 +2,7 @@
|
|||
# SPDX-FileCopyrightText: Copyright (C) 2026 Catcrafts®
|
||||
# Maintainer: Jorijn van der Graaf <jorijnvdgraaf@catcrafts.net>
|
||||
# Binary packaging: wraps a crafter-build binary cross-compiled per the
|
||||
# README's "Cross-compiling" section into a proper apk — used by this repo's
|
||||
# cross-compiling flow of AGENTS.md §4.3 into a proper apk — used by this repo's
|
||||
# package CI (packaging/build-package.sh, which also seds pkgver from
|
||||
# implementations/main.cpp) and runnable by hand. The source tarball is
|
||||
# produced by packaging/make-bin-tarball.sh; the desktop/preset files and
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
# SPDX-License-Identifier: GPL-3.0-only
|
||||
# SPDX-FileCopyrightText: Copyright (C) 2026 Catcrafts®
|
||||
# CI package build: cross-compile imsd for aarch64 with crafter-build (the
|
||||
# README's "Cross-compiling" flow), run the test suite natively, and package
|
||||
# cross-compiling flow of AGENTS.md §4.3), run the test suite natively, and package
|
||||
# the result via packaging/APKBUILD.binary. Expects an x86_64 Alpine
|
||||
# environment with root — the workflow runs it in an alpine:edge job
|
||||
# container on an ordinary runner. Root only installs packages and hands off
|
||||
|
|
|
|||
|
|
@ -3,8 +3,8 @@
|
|||
# SPDX-FileCopyrightText: Copyright (C) 2026 Catcrafts®
|
||||
#
|
||||
# ExecStartPost of imsd-ofonod.service. GNOME Calls 50.0 keeps a stale modem
|
||||
# when org.ofono vanishes and dials nothing until it is restarted (README,
|
||||
# Known gaps), so every start of imsd-ofonod after org.ofono went away
|
||||
# when org.ofono vanishes and dials nothing until it is restarted (AGENTS.md
|
||||
# §8.3, Known gaps), so every start of imsd-ofonod after org.ofono went away
|
||||
# restarts the Calls daemon of each user running one. Its first start since
|
||||
# boot is not one: no Calls has seen org.ofono go, and a Calls that runs
|
||||
# already (a login during the bring-up) is left alone. The unit's own
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ TimeoutStartSec=900
|
|||
# /run/imsd.env: written by ims-pdn-up.sh (DEV= the connected ims netdev,
|
||||
# LOCAL= the PDN address ModemManager assigned to it).
|
||||
# /etc/imsd.env: admin configuration — PCSCF= is REQUIRED (the carrier's
|
||||
# P-CSCF address; see the README's Configuration section) and wins over the
|
||||
# P-CSCF address; see AGENTS.md §10, or the README) and wins over the
|
||||
# runtime-derived values.
|
||||
EnvironmentFile=-/run/imsd.env
|
||||
EnvironmentFile=-/etc/imsd.env
|
||||
|
|
|
|||
Loading…
Reference in a new issue