Skip to content

Docs: make the README's tool list match what ships - #33

Merged
havokentity merged 2 commits into
mainfrom
fix/readme-drift
Aug 26, 2026
Merged

Docs: make the README's tool list match what ships#33
havokentity merged 2 commits into
mainfrom
fix/readme-drift

Conversation

@havokentity

Copy link
Copy Markdown
Owner

Today's nine merges left the README describing a smaller, older tool box than the one the code actually builds. This is a docs-only pass over every count, list and claim in README.md against Sources/DMonteCore/ToolboxCatalog.swift, Scripts/package_app.sh and Packaging/.

Drift found and fixed

Where What was wrong Now
README.md:5 "26 fast, focused utilities" — the catalog has 27 entries; File Shelf was never counted 27
README.md:48 A second Dev Tools row, the pre-JWT wording, making the table 28 rows for 27 tools. Commit 91aa447 corrected the original line; the merge for #10 resolved a conflict by keeping both Duplicate row removed
README.md:25 System Monitor described as live metrics only Adds the last-minute sparklines and the five busiest processes by CPU or memory
README.md:27 Clean Drive described as caches/logs/temp only Adds developer junk listed directory by directory
README.md:28 Disk Usage Analyzer described as a treemap you can only look at Adds reveal / copy path / trash from a result row
README.md:37 Window Manager listed only the snap grid and ⌃⌥ + arrows Adds next-display move (⌃⌥⌘→) and undo (⌃⌥⌫)
README.md:38 Audio Switcher described as one-click default switching only Adds named profiles that set input and output together

The table now lists all 27 catalog tools exactly once, with no row for a tool the catalog does not have — checked in both directions.

Checked and deliberately left alone

  • Uninstall Apps — the row already said "Remove apps and their leftover support files". It was aspirational before today and is simply true now, so nothing to change.
  • Grab Text — the ⌃⌥G shortcut was added to the row in the feature commit itself.
  • Packaging — no drift. All 27 helpers in package_app.sh name a Packaging/*Info.plist that exists; the only unreferenced plist is the main app's Info.plist, which package_app.sh copies directly; every helper's CFBundleIdentifier matches its catalog bundleID; nothing references a removed tool.
  • Other claimsmacOS 14+ matches Package.swift's .macOS(.v14); Swift 6.1 matches the tools version; Volume Mixer's macOS 14.2+ matches the availability guards; Video Splitter's 15/30/60/90 matches clipLengthChoices.
  • Permissions section — Disk Analyzer and Download Video both surface Full Disk Access prompts that this list does not mention. Left as-is: the section is scoped to TCC grants a tool requests on first use, Full Disk Access cannot be requested that way (the tools show a banner pointing at System Settings), and this predates today's merges. Worth a separate decision.
  • CHANGELOG.md untouched — a release is being prepared from it.

Verification

  • swift buildBuild complete!
  • swift testExecuted 1182 tests, with 0 failures (0 unexpected) in 6.244 (6.309) seconds

ToolRegistrationConsistencyTests passes; note it cross-checks catalog / packaging script / manifest, not the README, which is why this drift was invisible to CI.

Bumps VERSION to 0.16.0 and closes the changelog section for the release: File
Shelf as a new tool, support-file removal in Uninstall Apps, next-display moves
and an arrange undo in Window Manager, per-directory listing in Clean Drive,
acting on scan results in Disk Usage Analyzer, a global OCR shortcut in Grab
Text, sparklines and a top-process list in System Monitor, saved device profiles
in Audio Switcher, and the store-file and threading hardening that followed.

Moves the File Shelf entry out of the 0.15.0 section, where 5f2b0b6 filed it.
File Shelf was merged after v0.15.0 was tagged, so the entry claimed a tool that
is not in the build users already have, and it would have gone missing from the
release that actually carries it — the one place someone would look for it. The
0.15.0 section is now byte-identical to the tag again, and File Shelf leads
0.16.0's Added list where the other new tools sit in their own releases.

Sparkle notes for the release are the usual short curated file rather than the
changelog section, which is 60 lines here — well past the point where the update
window grows taller than the screen and puts the Update button out of reach.
Eight tools in one release is more to cover than 0.15.0 had, so the notes lead
with File Shelf and reduce the rest to one line apiece.

Nothing else in the tree carries the version: the Info.plist strings are stamped
from VERSION by package_app.sh at build time, and a sweep for a hardcoded 0.15.0
outside the changelog found none.
The nine merges that landed today left the README describing a smaller,
older tool box than the one in ToolboxCatalog.

The headline count was one short: File Shelf brought the catalog to 27
tools while the opening line still said 26. The table itself listed all
27 but carried a 28th row — a stale duplicate of Dev Tools without JWT,
reintroduced by the merge for PR #10 after the JWT commit had already
corrected the original. Every catalog tool now appears exactly once, and
no row names a tool the catalog does not have.

Five descriptions had been overtaken by the features merged today and
were understating the tool to the point of being wrong about what it can
do: System Monitor's sparklines and top-process list, Clean Drive's
per-directory developer junk, Disk Analyzer acting on a scanned row,
Window Manager's next-display move and undo, and Audio Switcher's device
profiles. Uninstall Apps and Grab Text needed nothing — the first
already claimed the leftover sweep that only now exists, and the second
had its shortcut added with the feature.

Packaging was already consistent and is untouched: all 27 helpers in
package_app.sh resolve to a Packaging/*Info.plist that exists, every
plist but the main app's Info.plist is referenced, and each helper's
CFBundleIdentifier matches its catalog entry.
@havokentity
havokentity merged commit fecfadd into main Aug 26, 2026
1 check passed
@havokentity
havokentity deleted the fix/readme-drift branch August 26, 2026 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant