Skip to content

Document loader build and payload workflow#5

Closed
ericlewis wants to merge 1 commit into
codex/disable-reva-patchingfrom
codex/document-loader-workflows
Closed

Document loader build and payload workflow#5
ericlewis wants to merge 1 commit into
codex/disable-reva-patchingfrom
codex/document-loader-workflows

Conversation

@ericlewis

Copy link
Copy Markdown
Collaborator

Summary

  • Document prerequisites, build commands, generated startup code, and patcher inputs/outputs.
  • Document the payload.bin binary layout and entry function ABI.
  • Clarify that checked-in constants only cover Playdate OS 3.0.2 today.

Why

New people did not have enough instructions to build or use the loader. The README did not say which tools are needed, when to run the generated startup step, what firmware files to place in the repo, or how payload.bin is laid out.

Verification

  • git diff --check
  • reviewed README diff for markdown table and command formatting

@ericlewis ericlewis changed the title [codex] Document loader build and payload workflow Document loader build and payload workflow May 10, 2026
@ericlewis ericlewis added the documentation Improvements or additions to documentation label May 10, 2026
@ericlewis ericlewis marked this pull request as ready for review May 10, 2026 04:46
@ericlewis ericlewis requested a review from mindstormpro May 10, 2026 05:05
@ericlewis ericlewis self-assigned this May 10, 2026
Why: New people did not have enough instructions to build or use the loader. The README did not say which tools are needed, when to run the generated startup step, what firmware files to place in the repo, or how /payload.bin is laid out. This writes those steps in plain language so a reader can go from a fresh clone to a patched firmware file.
@ericlewis ericlewis force-pushed the codex/document-loader-workflows branch from 6cf4709 to 1a66371 Compare May 10, 2026 05:09
@ericlewis ericlewis changed the base branch from main to codex/disable-reva-patching May 10, 2026 05:10
@ericlewis

Copy link
Copy Markdown
Collaborator Author

Replaced by #16 with the cleaned branch name.

@ericlewis ericlewis closed this May 10, 2026
@ericlewis ericlewis deleted the codex/document-loader-workflows branch May 10, 2026 05:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant