doc: readme: add quickstart installation instructions#10665
doc: readme: add quickstart installation instructions#10665lgirdwood wants to merge 1 commit intothesofproject:mainfrom
Conversation
lgirdwood
requested review from
dbaluta,
kv2019i,
lbetlej and
plbossart
as code owners
There was a problem hiding this comment.
Pull request overview
Adds a Quickstart section to the top-level README to help new contributors bootstrap a SOF development environment via an interactive installer script.
Changes:
- Add a new “Quickstart” section to README.md
- Document a one-line
curl+bashinvocation forsdk-install.sh - Briefly describe what the installer sets up (deps, repos, venvs, Zephyr SDK, QEMU)
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| You can easily set up the complete SOF development environment, including Zephyr SDK and QEMU, by running our interactive installer script. To run the installer locally: | ||
|
|
||
| ```bash | ||
| bash <(curl -sL https://raw.githubusercontent.com/thesofproject/vscode-workspace/main/sdk-install.sh) |
There was a problem hiding this comment.
The Quickstart recommends executing a remote script directly from raw.githubusercontent.com and tracking the main branch. This is a supply-chain risk and also reduces reproducibility (the contents can change over time). Consider switching to a safer pattern like downloading to a file for inspection, using curl fail-fast flags (e.g., fail on HTTP errors), and/or pinning to a specific tag/commit plus publishing a checksum/signature users can verify.
| bash <(curl -sL https://raw.githubusercontent.com/thesofproject/vscode-workspace/main/sdk-install.sh) | |
| curl -fsSLo sdk-install.sh https://raw.githubusercontent.com/thesofproject/vscode-workspace/<TAG>/sdk-install.sh | |
| bash sdk-install.sh |
There was a problem hiding this comment.
Done! I have updated the Quickstart guide to use the safer curl -fsSLo sdk-install.sh ... format as suggested.
Add a one-line curl command to install the SOF development environment using sdk-install.sh. This makes it easier for new users to bootstrap their environment interactively. Signed-off-by: Liam Girdwood <[email protected]>
Add a one-line curl command to install the SOF development environment using sdk-install.sh. This makes it easier for new users to bootstrap their environment interactively.