diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2de60f..f807413 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,6 +16,7 @@ Work inside the dev shell (`direnv allow` once). Run `cargo clippy - `nix build .#checks.x86_64-linux.boot`: boots a VM and reads the screen with OCR; screenshots land in `result/`. Run it by hand with `nix run .#checks.x86_64-linux.boot.driverInteractive`, then `test_script()`. + The images in `docs/` are crops of these screenshots. Prefix the VM commands with `env -u LD_LIBRARY_PATH` when the shell exports libraries that clash with QEMU's. diff --git a/README.md b/README.md index 5b20db5..b88b2f6 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ A live tree of systemd jobs on the boot console, in the spirit of nix-output-monitor. It replaces the scrolling kernel and systemd lines with the units still pending and a timeline of the ones that ran. +![The initrd: pending units on top, the timeline below](docs/initrd.png) +![Stage 2: the initrd collapsed, a failed unit, three still running](docs/stage-2.png) + It needs systemd ≥ 246 as PID 1, libdbus and a virtual terminal (it draws on tty12). With a systemd initrd it starts about a second after the kernel and follows the boot through the switch to the real root; without one it starts in diff --git a/docs/initrd.png b/docs/initrd.png new file mode 100644 index 0000000..4f7205e Binary files /dev/null and b/docs/initrd.png differ diff --git a/docs/stage-2.png b/docs/stage-2.png new file mode 100644 index 0000000..fef2768 Binary files /dev/null and b/docs/stage-2.png differ