Skip to content

Commit cd8915e

Browse files
committed
readme: Update build instructions to support python venv
This is a necessary part of the build instructions, and not immediately obvious to a new user without looking through the seperate online getting started guide. This example should serve as a "one-place" to get started. Signed-off-by: James Walmsley <[email protected]> <!-- ps-id: 7c1fc03a-7c2a-4d90-8a02-ca227114ec4e -->
1 parent 7e65a44 commit cd8915e

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,25 @@ Before getting started, make sure you have a proper Zephyr development
5454
environment. Follow the official
5555
[Zephyr Getting Started Guide](https://docs.zephyrproject.org/latest/getting_started/index.html).
5656

57+
58+
### Python VENV
59+
60+
To get started its recommended to initialize a virtual-environment for python.
61+
62+
```
63+
mkdir -p my-workspace
64+
cd my-workspace
65+
python -m venv .venv
66+
source .venv/bin/activate # note. activate.{fish,csh} etc for other shells!
67+
```
68+
69+
From there you can install west and all the required python dependencies for zephyr's build system
70+
without touching your system's python installation.
71+
72+
```
73+
pip install west
74+
```
75+
5776
### Initialization
5877

5978
The first step is to initialize the workspace folder (``my-workspace``) where
@@ -68,6 +87,12 @@ cd my-workspace
6887
west update
6988
```
7089

90+
Before building, ensure all required python packages are installed
91+
92+
```
93+
west packages pip --install
94+
```
95+
7196
### Building and running
7297

7398
To build the application, run the following command:

0 commit comments

Comments
 (0)