mirror of
https://github.com/openglow-org/forgefirm.git
synced 2026-09-27 16:51:12 -07:00
docs: present-state build and update docs; fix the ring-size arithmetic
- kas/README.md: the real-time rationale rests on the feeder's bounded queue depth, not ring size; the ring is 16 MiB (~84 s at 200 kHz, ~28 min at the 10 kHz cloud tick), a capacity for cloud-mode preload. - BUILD.md, kas config, release checklist, cold-build workflow: only forgefirm and meta-openglow (branch scarthgap) are cloned as siblings; every ForgeFIRM source repo is fetched by pinned SRCREV. - UPDATE-SYSTEM.md reads as the present-state design: the cloud-mode compatibility baseline is the cloud client's configured firmware version, not release metadata; decisions and open items listed plainly. - README.md states what GRBL mode still needs the Glowforge service for (camera-referenced homing) and what runs without it. - BRINGUP.md: generic build-host and fwup-lab references, the retained reproductions of the no-fire drill, the System tab. - LIGHTBURN.md: the arm-window timeouts are machine settings. - forgefirm-image.bb describes forgectrl as the machine-services daemon and points at the right backlog entry. - American spelling throughout.
This commit is contained in:
@@ -26,20 +26,21 @@ Do not build as root (the Yocto sanity checks refuse it).
|
||||
|
||||
## Get the sources
|
||||
|
||||
Clone the repos as siblings (the kas config references `meta-openglow` at
|
||||
`../meta-openglow` while it is under active Scarthgap migration):
|
||||
Clone the two repos as siblings (the kas config references `meta-openglow`,
|
||||
branch `scarthgap`, at `../meta-openglow`; kas fetches the upstream Yocto
|
||||
layers itself, and every ForgeFIRM source repo — the kernel module, the
|
||||
controller, the daemon, the cloud apps — is fetched by its recipe at a pinned
|
||||
revision):
|
||||
|
||||
```console
|
||||
git clone https://github.com/ScottW514/forgefirm.git
|
||||
git clone https://github.com/ScottW514/meta-openglow.git
|
||||
git clone https://github.com/ScottW514/kernel-module-glowforge.git
|
||||
git clone -b scarthgap https://github.com/ScottW514/meta-openglow.git
|
||||
```
|
||||
|
||||
```
|
||||
openglow-forgefirm/
|
||||
├── forgefirm/ ← base repo, build runs here
|
||||
├── meta-openglow/
|
||||
└── kernel-module-glowforge/
|
||||
└── meta-openglow/
|
||||
```
|
||||
|
||||
## Build the image
|
||||
@@ -86,5 +87,6 @@ cd build/tmp/deploy/images/glowforge
|
||||
sudo zcat forgefirm-image-glowforge.rootfs.wic.gz | dd of=/dev/sdX bs=1M
|
||||
```
|
||||
|
||||
To install onto the factory eMMC (dual-boot with the Glowforge firmware), see
|
||||
To install onto the factory eMMC (into the unused A/B slot, with the factory
|
||||
firmware archived first — one OS runs at a time), see
|
||||
[`INSTALL.md`](INSTALL.md).
|
||||
|
||||
Reference in New Issue
Block a user