Breadway/bos
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions
bos/breadhelp/content/getting-started/01-what-is-bos/content.md
Breadway 664298b6b4 Extract bos-settings to its own repo; add breadhelp; JSON-driven Hyprland config 
bos-settings moves to git.breadway.dev/Breadway/bos-settings (full history
preserved via git-filter-repo) so its release cadence is decoupled from
BOS's own. breadhelp takes its place as this repo's workspace member: a
GTK4 onboarding/help center replacing the old bos-welcome/bos-keybinds
bash scripts with searchable guides, an interactive keybind viewer
(sourced from the new keybinds.toml, not parsed out of hyprland.lua or
hardcoded), a troubleshooting wizard with one-click fixes, and a proper
first-run tour. bos-netcheck extracts bos-welcome's network-check half,
which still needs to run every login independent of breadhelp's own
first-run gating.

hyprland.lua's keybinds/settings/monitors/autostart are now JSON-driven
(binds.json/settings.json/monitors.json/autostart.json) with every
loader pcall-wrapped and falling back to hardcoded defaults per field on
bad or missing config, so bread* apps (bos-settings' new editors, and
breadhelp's keybind viewer) can read/write this config without ever
being able to leave the compositor unable to start.

CI's package.yml now builds breadhelp instead of bos-settings on tag
push; bos-settings needs its own equivalent workflow in its new repo
(not yet set up).
2026-07-05 09:16:14 +08:00

910 B
Raw Blame History

Welcome to BOS

BOS (the Bread Operating System) is a complete Hyprland desktop with the bread ecosystem preinstalled: a bar, a launcher, notes, Wi-Fi profiles, and a settings app that needs no config files.

The basics

  • SUPER is the Windows/Cmd key — almost everything starts with it.
  • [Show Keybind]super + /[/Show Keybind] shows the full keybind cheatsheet any time.
  • [Show Keybind]super + ,[/Show Keybind] opens BOS Settings — configure the bar, launcher, Wi-Fi, notes, snapshots, and package updates all in one place.
  • [Show Keybind]super + space[/Show Keybind] opens the app launcher (breadbox).
  • [Show Keybind]super + return[/Show Keybind] opens a terminal.

Safety net

Your system snapshots itself on every package change. If an update breaks something, roll it back from BOS Settings or pick a snapshot right from the GRUB menu at boot.

  • [Run]bos-settings|Open BOS Settings[/Run]