Breadway/breadhelp
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions
breadhelp/README.md
Breadway af6ba1bd82
Some checks failed
check / check (push) Failing after 6s
Details
dev release / build (push) Successful in 29s
Details
Add a day-zero first-run wizard before the desktop tour 
First-boot --autostart now walks Welcome, timezone, network hint, updates,
and an optional snapper day-zero snapshot in the existing help window, then
hands off to the live cheatsheet tour. Existing onboarded users are skipped.
2026-08-16 00:00:23 +08:00

1.2 KiB
Raw Blame History

breadhelp

Onboarding and help center for BOS (Bread Operating System) — GTK4, a searchable guide library, an interactive keybind viewer, a troubleshooting wizard with one-click fixes, a short first-boot day-zero wizard (timezone, network hint, updates, snapper), and a live guided tour overlay that spotlights real on-screen bread* apps (breadbar, breadbox, ...) instead of walking through a static wizard.

Split out of the bos repo into its own repo so a breadhelp release doesn't require a BOS ISO release, and vice versa. A bakery product (bakery.toml + bakery CI) and baked into the BOS ISO — not pacman-packaged.

Building

cargo build --release

Packaging / releasing

See CONTRIBUTING.md for the single-trunk + tag model. main publishes a bakery dev build; a vX.Y.Z-rc.N tag publishes beta; a vX.Y.Z tag publishes stable. The leftover packaging/ tree is not a pacman source — bakery is canonical (see packaging/README.md).

bread event integration

Works the same with or without breadd. When the main window is shown, breadhelp publishes bread.help.opened. See EVENTS.md.