Skip to content

Document loader build and payload workflow#16

Open
ericlewis wants to merge 1 commit into
disable-reva-patchingfrom
document-loader-workflows
Open

Document loader build and payload workflow#16
ericlewis wants to merge 1 commit into
disable-reva-patchingfrom
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

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 added the documentation Improvements or additions to documentation label May 10, 2026
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