Rewrite README with verified build docs (issue #26)#1
Merged
Conversation
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 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
1 participant
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 flipperdevices#26
README rewrite with four sections from issue flipperdevices#26. Every build command was run in the repo's own container image before writing it down.
What's in this
roc-pcnotrock-pc,evbnotevb1)rk3576-linux-build(old repo name) instead offlipperone-linux-build-scripts. HTTP 301 redirect kept builds working but the container's working directory had the wrong name.Build runs
All commands verified in
podman run --privileged -v $PWD/out:/artifactsagainst the repo's own container image:build-uboot.shbuild-kernel-mainline.shbuild-kernel-bsp.shprebuilt/linux/by default and the final mv step conflicts)build-images.shdebian-512-*-20260611-1448.img.gzfor all 8 boardsCorrections from build runs
rk3576_spl_loader_*.bin- no such file exists; actual filename isrk3576_loader_v*.bindebian-<board>.img.gz; actual format isdebian-512-<board>-<timestamp>.img.gzqemu-user-binfmt,device-tree-compiler,mmdebstrap,systemd-container,libglib2.0-dev,libostree-dev,fakemachine);gdown/repoare not in trixie apt and were removed;apt install -t testing debosreplaced withgo installout/u-boot/,out/images/); manual builds useprebuilt/u-boot/andout/(the script defaults)pipx install --globalneedssudoon a non-root install (writes to/opt/pipxand/usr/local/bin)