Skip to content

Restructure README around a quick start for new users - #153

Merged
sshcrack merged 1 commit into
masterfrom
docs/readme-quick-start
Nov 10, 2026
Merged

sshcrack merged 1 commit into
masterfrom
docs/readme-quick-start

Conversation

@sshcrack

@sshcrack sshcrack commented Nov 10, 2026 •

Copy link
Copy Markdown
Owner

What

  • Quick start is now the first section: a "You need" box (Pi 3/4 not 5, 64-bit OS, user `pi`, HUB75 panels + adapter, 5 V supply), a path picker, then four steps: prepare the Pi (disable onboard sound, previously buried in Hardware), install, open the web UI, optional desktop app. AI-agent setup and the emulator are subsections.
  • Hardware and "Start from scratch" merged into one Hardware section (shopping list, numbers, wiring, flashing).
  • Install guide is now reference material (no duplicated install steps).
  • Sections reordered: Install guide → Desktop app → Web UI → Features → Configuration → Troubleshooting → REST API → Development.
  • Desktop app: Linux tarball install, version argument, `~/.local/bin` PATH note.
  • Build prerequisites: vcpkg is found without `VCPKG_ROOT`; Node 22 (as in CI).
  • `docs/AGENT_SETUP.md`: fixed a link to the removed `#start-from-scratch` anchor.

Why

New users had to scroll past features and screenshots, and the Pi preparation step was easy to miss.

Verification

Claims checked against the installer, debconf templates, web UI nav, desktop app labels, server routes and release asset names. All in-page anchors resolve (script check). Docs-only change, no screenshots.


📦 Build artifacts

Built from 749f6cb · CI run

Platform Download Archive size
desktop-linux-build Download 263 MiB
desktop-windows-build Download 40 MiB
led-matrix-build Download 356 MiB
web-build Download 0 MiB

Put requirements, Pi preparation, install, first steps and the desktop app
at the top, merge hardware and start-from-scratch, turn the install guide
into reference material, and update the build prerequisites (vcpkg is
found without VCPKG_ROOT, Node 22).
@sshcrack
sshcrack merged commit 96045c9 into master Nov 10, 2026
3 checks passed
@sshcrack
sshcrack deleted the docs/readme-quick-start branch November 10, 2026 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant