Skip to content

Commit 4be9bba

Browse files
lrgirdwolgirdwood
authored andcommitted
doc: readme: add quickstart installation instructions
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 <liam.r.girdwood@linux.intel.com>
1 parent 75b9715 commit 4be9bba

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,17 @@ Additional community support is available via the `#sof` channel in the Zephyr P
1414

1515
See [docs](https://thesofproject.github.io/latest/index.html)
1616

17+
## Quickstart
18+
19+
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:
20+
21+
```bash
22+
curl -fsSLo sdk-install.sh https://raw.githubusercontent.com/thesofproject/vscode-workspace/main/sdk-install.sh
23+
bash sdk-install.sh
24+
```
25+
26+
The script will guide you through the process of installing system dependencies, cloning the repositories, configuring Python virtual environments, and setting up the Zephyr SDK and QEMU.
27+
1728
## Running the tests
1829

1930
See [unit testing documentation](https://thesofproject.github.io/latest/developer_guides/unit_tests.html)

0 commit comments

Comments
 (0)