Retire TODO.md and correct the README's inherited claims #43

Merged

mysticalsoap merged 2 commits from docs/readme-todo into trunk

2026-08-18 18:08:06 -04:00

mysticalsoap commented

2026-08-18 18:04:34 -04:00

Owner

Problem: The README still carried upstream's "About this project" section
(qomui's author describing qomui), Installation pointers at samicrusader's
pkgbuilds repo and a GitHub releases tab that doesn't exist here, a Changelog
section that duplicated CHANGELOG.md while disagreeing with it about what
0.8.3 contained, and factual drift (update interval, dependency list, a
python >=3.5 floor the codebase's f-strings already broke). TODO.md carried
no signal, and CHANGELOG.md didn't say whether it was current or historical.

Fix: First commit deletes TODO.md and settles the changelog question:
CHANGELOG.md stays the live release record, with a header scoping everything
through 0.8.4 as upstream's; aqomui's own entries start at the 0.9.0 release.
Second commit deletes the README's About and Changelog sections, points
Installation at the in-repo packaging/arch/PKGBUILD plus a plain setup.py
install, fixes the update interval to five days, adds netifaces and
cryptography to the dependencies, and rewords the two remaining
first-person-upstream passages.

TODO.md's one live idea became #41 (OpenVPN over Tor). The README
deliberately gains no Debian install line because debian/package.sh clones a
nonexistent repo -- filed as #42.

Verification: Markdown-only diff. Each factual claim was checked against
the repo: the five-day interval is days_since >= 5 in aqomui_gui.py,
netifaces and cryptography are imported by the code and required by the
PKGBUILD, packaging/arch/PKGBUILD and debian/ are tracked on trunk, and CI
tests on current Arch python only.

Closes #28. Closes #29.

🤖 Generated with Claude Code

**Problem:** The README still carried upstream's "About this project" section (qomui's author describing qomui), Installation pointers at samicrusader's pkgbuilds repo and a GitHub releases tab that doesn't exist here, a Changelog section that duplicated `CHANGELOG.md` while disagreeing with it about what 0.8.3 contained, and factual drift (update interval, dependency list, a python >=3.5 floor the codebase's f-strings already broke). TODO.md carried no signal, and `CHANGELOG.md` didn't say whether it was current or historical. **Fix:** First commit deletes TODO.md and settles the changelog question: `CHANGELOG.md` stays the live release record, with a header scoping everything through 0.8.4 as upstream's; aqomui's own entries start at the 0.9.0 release. Second commit deletes the README's About and Changelog sections, points Installation at the in-repo `packaging/arch/PKGBUILD` plus a plain setup.py install, fixes the update interval to five days, adds netifaces and cryptography to the dependencies, and rewords the two remaining first-person-upstream passages. TODO.md's one live idea became #41 (OpenVPN over Tor). The README deliberately gains no Debian install line because `debian/package.sh` clones a nonexistent repo -- filed as #42. **Verification:** Markdown-only diff. Each factual claim was checked against the repo: the five-day interval is `days_since >= 5` in `aqomui_gui.py`, netifaces and cryptography are imported by the code and required by the PKGBUILD, `packaging/arch/PKGBUILD` and `debian/` are tracked on trunk, and CI tests on current Arch python only. Closes #28. Closes #29. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

mysticalsoap added 2 commits

2026-08-18 18:04:34 -04:00

change: drop TODO.md and scope CHANGELOG.md's inherited entries e25ff4de4e

TODO.md held four lines too vague to act on. Its salvageable content
moves to the issue tracker: OpenVPN over Tor becomes a tracked feature
issue; more providers is the constant background extension every
provider-import change already serves; Windows support is not feasible
for the current architecture.

CHANGELOG.md stays the live release record: a header now marks
everything through 0.8.4 as upstream's, with aqomui's own entries to
start at the 0.9.0 release.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

change: correct the README's inherited inaccuracies

ci / test (pull_request) Successful in 52s

Details

ci / test (push) Successful in 32s

Details

67ff4436ea

Delete the About section (upstream's author writing about qomui -- the
fork link at the top already carries the provenance) and the Changelog
section, which duplicated CHANGELOG.md while disagreeing with it about
what 0.8.3 contained. Point Installation at the in-repo PKGBUILD and a
plain setup.py install instead of samicrusader's pkgbuilds repo and a
GitHub releases tab that doesn't exist here. Fix the update interval
(five days, matching the code and the Options section, not a week),
add netifaces and cryptography to the dependency list, drop the
python >=3.5 floor the f-strings already broke, and reword the two
remaining first-person-upstream passages to neutral voice.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

mysticalsoap merged commit 67ff4436ea into trunk

2026-08-18 18:08:06 -04:00

mysticalsoap deleted branch docs/readme-todo

2026-08-18 18:08:06 -04:00

mysticalsoap referenced this pull request

2026-08-18 18:11:16 -04:00

Drop the inherited Debian packaging #45