Skip to content

Restructure the README around the reader's path#54

Merged
sturimcode merged 1 commit into
mainfrom
readme-improvements
Jul 13, 2026
Merged

Restructure the README around the reader's path#54
sturimcode merged 1 commit into
mainfrom
readme-improvements

Conversation

@sturimcode

Copy link
Copy Markdown
Owner

Full audit of the README against the code, plus a restructure around the reader's path instead of the order sections were written in. No code changes.

Fixes

  • The tagline said "macOS and Windows" while the doc itself has a Headless Linux section; it now names all three platforms.
  • --history and --headless existed in the CLI but not in the README. Both documented; --version, --config, and --db get a pointer to --help.
  • The systemd recipe used --headless without the flag being documented anywhere.

Restructure

  • "How Garmin login works" moved from before Install to after "How it works": new users no longer read Cloudflare lore before the install command.
  • Install split into macOS / Windows / Linux subsections, uv first on all of them.
  • Automatic sync now opens platform-neutral, then per-OS bullets (Launch Agent / Scheduled Task / none, use systemd), matching what platform_support actually does.
  • The standalone Updating section is gone; updating was explained three times, now once under Usage.
  • Credential storage merged into Security as a per-platform list of where secrets live.
  • Known quirks reordered by blast radius: app-must-process-weigh-in first, rounding trivia last.
  • Usage flags grouped by task; Stability column dropped from the targets table (every row said Stable).

Left alone on purpose

  • ~/.garmin-sync/ naming (renaming breaks installs).
  • Tests section: making it a real Development section needs a decision on the contributor setup, since pytest is not declared in pyproject.

Verified against code: weekly update check (shared.py), diagram filenames, log paths, and the generic platform layer's no-agent behavior.

🤖 Generated with Claude Code

- Fix the tagline: it said macOS and Windows while a whole section
  documented headless Linux
- Document the missing flags (--history, --headless) and point at
  --help for --version/--config/--db
- Group the Usage list by task instead of one flat pile
- Move "How Garmin login works" below install and usage; new users hit
  Cloudflare lore before the install command
- Split Install into macOS / Windows / Linux with uv as the lead path
- Make Automatic sync platform-neutral with per-OS bullets
- Fold the redundant Updating section into Usage (it said the same
  thing three times)
- Merge Credential storage into Security as a per-platform list
- Reorder Known quirks: the app-must-process-weigh-in quirk affects
  everyone, resolution rounding affects few
- Drop the Stability table column (every row said Stable)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@sturimcode sturimcode merged commit 180dacb into main Jul 13, 2026
6 checks passed
@sturimcode sturimcode deleted the readme-improvements branch July 13, 2026 21:55
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