Skip to content

docs: README Docker section + hatch-vcs notes#22

Merged
Xitee1 merged 1 commit into
mainfrom
docs/readme-docker-examples
May 12, 2026
Merged

docs: README Docker section + hatch-vcs notes#22
Xitee1 merged 1 commit into
mainfrom
docs/readme-docker-examples

Conversation

@Xitee1
Copy link
Copy Markdown
Owner

@Xitee1 Xitee1 commented May 12, 2026

Summary

  • Add a Docker section with docker run examples for all four subcommands. Documents the three in-container caveats:
    • --device=/dev/sr0 doesn't populate /sys/block/, so auto-detection won't find the drive — pass -D /dev/srN explicitly.
    • burn needs CAP_SYS_RAWIO (--privileged is the easy path; --cap-add=SYS_RAWIO is the surgical one).
    • verify <iso-file> doesn't work in the slim image because udisksctl needs a running udisksd/dbus. Workaround: pre-mount on host.
  • Sync README with the new versioning model: replace the 'version read from __init__.py' wording with a short hatch-vcs explainer (tag → _version.py__init__.py), mention that _version.py is gitignored.

Test plan

  • Manual read-through; sections flow naturally between Installation and Usage.
  • ruff check + ruff format --check pass (README-only change, but project policy says always lint).
  • Reviewer eyeballs the Docker examples and confirms paths/flags match real usage.

🤖 Generated with Claude Code

- New 'Docker' section with pull instructions and concrete examples for
  create / burn / verify / extract via `docker run`. Documents the three
  in-container caveats: no /sys/block/sr* auto-detection, growisofs needs
  CAP_SYS_RAWIO (or --privileged), and `verify <iso-file>` requires a
  running udisksd that the slim image doesn't ship.
- Replace stale 'Version is read from __init__.py' wording with a short
  hatch-vcs explainer (tag → _version.py → __init__.py), plus a note that
  _version.py is generated/gitignored.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Xitee1 Xitee1 merged commit 9c14cdd into main May 12, 2026
1 check passed
@Xitee1 Xitee1 deleted the docs/readme-docker-examples branch May 12, 2026 09:57
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