Skip to content

Commit 7a17705

Browse files
committed
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 b7571f5 commit 7a17705

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

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

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

16+
## Quickstart
17+
18+
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:
19+
20+
```bash
21+
curl -fsSLo sdk-install.sh https://raw.githubusercontent.com/thesofproject/vscode-workspace/main/sdk-install.sh
22+
bash sdk-install.sh
23+
```
24+
25+
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.
26+
1627
## Running the tests
1728

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

0 commit comments

Comments
 (0)