Skip to content

docs: state that it builds on Intel, drop the toolchain commentary - #4

Merged
gridboy merged 1 commit into
mainfrom
docs/build-notes
Aug 11, 2026
Merged

gridboy merged 1 commit into
mainfrom
docs/build-notes

Conversation

@gridboy

@gridboy gridboy commented Aug 11, 2026

Copy link
Copy Markdown
Owner

What this changes

Rewrites the build section around what is actually true, and drops the toolchain commentary around it.

Why

The section claimed "expect this not to build as-is on a modern Mac". That is wrong — it builds and runs on an Intel Mac. The README now says so, attributed to the maintainer, because this repository's CI only parses the sources and cannot confirm a build.

The real portability limit is narrower than the old text implied, and is now stated precisely: the vendored libusb-1.0 binaries are x86_64 only (lipo -info reports a non-fat x86_64 .dylib and .a), so Apple Silicon needs them rebuilt or replaced with a universal build before it will link. Everything else the old paragraph listed as a blocker was not one.

Also corrects the project format note: it reads objectVersion = 46, not the "Xcode 3 era" format the README claimed. The Xcode 3 artefacts were the .pbxuser and .mode1v3 files, removed when the repository was reorganised.

How it was verified

  • sh scripts/syntax-check.sh passes (documentation only, no source changes)
  • lipo -info on both vendored libusb binaries, for the architecture claim
  • Built — the Intel build is the maintainer's report, not reproduced here
  • Run against real Kinect hardware

Provenance

  • No third-party licence header, copyright notice, CONTRIB or AUTHORS file altered
  • No new vendored code

The build section claimed 'expect this not to build as-is on a modern Mac'. That is
wrong: it builds and runs on an Intel Mac, per the maintainer. Replaced with that,
attributed, since CI here only parses the sources and cannot confirm it.

The real portability limit is narrower and now stated as such: the vendored libusb
binaries are x86_64 only, so Apple Silicon needs them rebuilt or replaced before it
links. Verified with lipo -info.

Also corrects the project format note. It reads objectVersion 46, not the Xcode 3 era
format claimed here - the Xcode 3 artefacts were the .pbxuser and .mode1v3 files, which
were removed when the repository was reorganised.
@gridboy
gridboy merged commit ed0b347 into main Aug 11, 2026
1 check passed
@gridboy
gridboy deleted the docs/build-notes branch August 11, 2026 16:19
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