Skip to content

Add Quick Start section with cheat sheet link to top of README - #37

Merged
miketsukerman merged 1 commit into
mainfrom
copilot/add-cheatsheet-link-to-readme
Oct 11, 2026
Merged

miketsukerman merged 1 commit into
mainfrom
copilot/add-cheatsheet-link-to-readme

Conversation

Copilot AI commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

The main README lacked a prominent link to docs/cheatsheet.md and an at-a-glance entry point for new users.

Changes

  • Added a ⚡ Quick Start section near the top of README.md (right after the intro paragraph) listing the four most needed commands to start building BSPs:
bsp tree                   # visual overview of the BSP registry
bsp list                   # list all available BSP presets
bsp build <bsp_name>       # build a BSP image
bsp shell <bsp_name>       # enter an interactive build-environment shell
  • Linked the Cheat Sheet from this section as the quick-reference entry point, with the existing full documentation following below.

Documentation-only change; the existing detailed "Quick Start" section further down is untouched.

Co-authored-by: miketsukerman <145971+miketsukerman@users.noreply.github.com>
@miketsukerman
miketsukerman marked this pull request as ready for review October 11, 2026 09:07
@miketsukerman
miketsukerman merged commit 17990d5 into main Oct 11, 2026
6 checks passed
@miketsukerman
miketsukerman deleted the copilot/add-cheatsheet-link-to-readme branch October 11, 2026 09:07
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.

2 participants