Skip to content

docs: add CLAUDE.md - #7

Merged
modfox merged 1 commit into
mainfrom
docs/claude-md
Nov 18, 2026
Merged

modfox merged 1 commit into
mainfrom
docs/claude-md

Conversation

@modfox

@modfox modfox commented Nov 18, 2026

Copy link
Copy Markdown
Owner

What

Adds a CLAUDE.md so Claude Code sessions in this repo start with the essentials:

  • Clean-room rules: vendor binaries stay local and gitignored; findings are written up in recon/*.md and spec/.
  • Commands: build, test, a single test, and the nib modes (run, log, touchlog, calibrate, capture).
  • Install notes: sign with the stable identity, never ad hoc (it resets the Privacy grants); stop the LaunchAgent before calibrating; releases stay dormant unless RELEASE_ENABLED is set.
  • Architecture: the three targets and the run pipeline (DeviceManager → decode → emitter/gestures → EventSink), how displays are matched, and how settings stay forward-compatible.
  • Device profiles: a model is data, not decode code; adding one follows docs/ADDING-A-DEVICE.md.
  • Tests: how the event state machines are tested without Accessibility.

It points to README.md, INSTALL.md, RELEASING.md and ADDING-A-DEVICE.md instead of repeating them.

Verified

  • Every type, path and command it names was checked against the code.
  • swift build and swift test (47 tests) pass on this commit's parent. The change is Markdown only.

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@modfox
modfox merged commit b47ddb7 into main Nov 18, 2026
1 check passed
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