Repository navigation
docs: make the from-scratch build and rename path work for outside developers - #81
Merged
Merged
Conversation
A clean-room run (anonymous clone, public ghcr images, no local toolchain or credentials) built the app and the firmware, but several documented steps assumed the reference workbench: - dev_deploy.sh only built with the self-built stage2 toolchain; it now falls back to the Docker devkit and deploys out/app/. - getting-started.md described the old buildkit artifact / update.img flow and root SSH; it now flashes the RustKVM image and turns on SSH through Settings (SSH access + developer mode). - README and README.zh-CN put dev_deploy.sh first and required stage2; they now lead with the devkit, note that no login is needed, and show how to use the pinned nightly and the published buildkit without stage2. - building.md: measured disk and time, WSL2 disk lives on C:, the firmware builder image is built locally from Docker Hub ubuntu:22.04. - New docs/customizing.md: hostname, UI name, USB descriptors, firmware version, root password and own build images. - build-firmware.sh removes the previous dated raw images before packing (two ~8 GB files per build day were never cleaned up). - MQTT discovery release_url pointed at the old foxxcn repository. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
github-actions
Bot
added
documentation
Rust-KVM
marked this pull request as ready for review
October 24, 2026 10:00
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.
Requested by 4c
Summary
Before: an outside developer following the README hit
dev_deploy.shfirst, which only builds with the self-builtstage2toolchain;getting-started.mddescribed flashing an old buildkit artifact (update.img) and logging in as root over SSH, which the current firmware disables; the zh-CN README did not mention the devkit at all; and there was no guide for shipping a renamed build.After: the README (both languages) leads with the Docker devkit,
dev_deploy.shfalls back to the devkit whenstage2is missing,getting-started.mdflashes the RustKVM image and turns on SSH through Settings → Security → SSH access and Settings → System → Developer mode,building.mdcarries measured disk/time figures and the WSL2 disk caveat, and the newdocs/customizing.mdcovers hostname, UI name, USB descriptors, firmware version, root password and your own build images.How
Found by a clean-room run: anonymous HTTPS clone into an empty directory with an empty
HOMEandDOCKER_CONFIG, anonymous pulls of bothghcr.io/rust-kvmimages,scripts/devkit.sh run scripts/build-app.sh(passed first try, 7 min), a rename tomykvm(mDNS default, UI strings, USB manufacturer) and rebuild (passed, 5 min),scripts/devkit.sh firmware-imagefrom scratch, andscripts/devkit.sh firmware patch build collectwithFW_VERSION=0.1.0-mykvm(passed, 7 min; the image embeds the renamed binary, sha256 checked). All 14 pinned SDK commits were fetched anonymously fromgithub.com/friendlyarm; the full 40 GB SDK sync itself was not repeated for lack of disk, the build reused the existing SDK checkout.Two small non-doc fixes:
build-firmware.shdeletes the previous dated raw images before packing (two ~8 GB files were left behind per build day), and the MQTT discoveryrelease_urlpointed at the oldfoxxcn/rustkvmrepository.Testing
cargo +nightly fmt --all(check)cargo +nightly clippy --workspace --release --all-targets -- -D warnings(CI)cargo +nightly test --workspace(CI)Checklist
#[allow(...)]suppressions and no newunwrap()/expect()in production pathsMissedTickBehavior::Delayrkvm-proto🤖 Generated with Claude Code