Rewrite README with verified build docs (issue #26) - #76
Merged
alchark merged 3 commits intoJun 19, 2026
Merged
alchark merged 3 commits into
alchark merged 3 commits into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Add four sections required by issue flipperdevices#26: Repos structure, Automated builds, How to build image manually, How to contribute. Every documented build command was verified inside the repo's own container image (localhost/fobl built from the Dockerfile): - build-uboot.sh: PASS — all 8 boards from flipperdevices/u-boot rk3576 - build-kernel-mainline.sh: PASS — Linux 7.1.0-rc6 arm64 .deb packages - build-kernel-bsp.sh: FAIL when run in parallel with mainline (mv cross-fs conflict); note added to not run builds in parallel - build-images.sh: PASS — debian-512-*-20260611-1448.img.gz produced for all 8 boards via debos fakemachine (KVM) Fixes from build verification: - Correct loader filename: rk3576_loader_v*.bin (not rk3576_spl_loader) - Correct image filename format: debian-512-<board>-<timestamp>.img.gz - Correct dep list: add 7 packages missing from old README; remove gdown/repo (not in trixie); use go install for debos (not apt) - Fold in PR flipperdevices#27 boards table with corrected target names: roc-pc (not rock-pc), evb (not evb1) - Preserve original SD card warning, Maskrom/Rockusb flashing prose Dockerfile fix: correct stale WORKDIR and clone URL from rk3576-linux-build to flipperone-linux-build-scripts (justified by container-quickstart build).
Flashing commands were using container output paths (out/u-boot/, out/images/) in the manual build section. Manual builds default to prebuilt/u-boot/ for bootloaders and out/ for disk images. Also add missing sudo to pipx install --global, which requires root on a non-root system install.
This was referenced Jun 11, 2026
alchark
requested changes
Jun 16, 2026
alchark
left a comment
Copy link
Copy Markdown
Collaborator
There was a problem hiding this comment.
Thank you for the contribution! This is a great improvement to our README, and I like a lot how it comes together now.
Would you mind having a look at some specific comments I've left inline?
Sorry, something went wrong.
- Add u-boot, rkbin, and TF-A repos to the Repos structure table - Add UFS storage notes for Rock 4D and NanoPi M5 boards - Remove stale "only Firefly supported by upstream U-Boot" claim; update to list all currently upstream-supported boards - Remove stale UFS-can't-boot note (driver merged upstream) - Add Rock 4D eMMC/FSPI0 pin-multiplexing warning - Rewrite branch model section: fork-first workflow for external contributors - Rewrite "Adding a new board": upstream-first sequence (Linux bindings → drivers → DTS → U-Boot defconfig); drop BL31 mention (not board-specific)
Copy link
Copy Markdown
Contributor
Author
cc @alchark |
Sorry, something went wrong.
alchark
approved these changes
Jun 17, 2026
alchark
left a comment
Copy link
Copy Markdown
Collaborator
There was a problem hiding this comment.
This looks great, thanks a lot for your contribution! I believe it's ready to merge. One minor comment left inside regarding rkbin - not a blocker though.
Sorry, something went wrong.
Comment thread
README.md
| | [flipper-linux-kernel](https://github.com/flipperdevices/flipper-linux-kernel) | Linux kernel patches and configuration for Flipper One RK3576-based boards | | ||
| | [flipperone-mcu-firmware](https://github.com/flipperdevices/flipperone-mcu-firmware) | Firmware for the low-power RP2350 MCU | | ||
| | [flipperdevices/u-boot](https://github.com/flipperdevices/u-boot) | Flipper fork of U-Boot; adds defconfigs for Flipper One and EVB1 on top of upstream | | ||
| | [flipperdevices/rkbin](https://github.com/flipperdevices/rkbin) | Rockchip binary firmware blobs (BL31) — used when `USE_BL31=vendor` | |
Copy link
Copy Markdown
Collaborator
There was a problem hiding this comment.
Not only BL31. It's the only source for the DDR initialization blob, and it also contains the necessary pieces to produce a Maskrom loader for flashing over USB with Rockchip default tools. The latter is not strictly required, because these days mainline U-boot also produces -usb471 and -usb472 binaries to boot directly over Maskrom (but that path is less documented)
Sorry, something went wrong.
Closed
Closed
alchark
pushed a commit
that referenced
this pull request
Jun 22, 2026
DDR init blob and Maskrom USB loader are always pulled from rkbin, not only when USE_BL31=vendor. The vendor BL31 is the only conditional part. Update the description accordingly. Fixes #76 (comment)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #26
README rewrite with four sections from issue #26. Every build command was run in the repo's own container image before writing it down.
What's in this
Build runs
All commands verified in podman run --privileged -v $PWD/out:/artifacts against the repo's own container image:
Corrections from build runs