Skip to content

Commit 5e50973

Browse files
committed
zephyr doc tweak
1 parent 2dbbc12 commit 5e50973

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

documentation/devices/zephyr.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Using the Moddable SDK with Zephyr
22

33
Copyright 2025-2026 Moddable Tech, Inc.<BR>
4-
Updated: January 16, 2026
4+
Updated: February 11, 2026
55

66
This document is a guide to building Moddable apps with the [Zephyr Project SDK](https://github.com/zephyrproject-rtos/zephyr/).
77

@@ -15,11 +15,11 @@ This document is a guide to building Moddable apps with the [Zephyr Project SDK]
1515
* [Instrumented](#build-instrumented)
1616
* [Release](#build-release)
1717
* Setup instructions
18-
*
18+
*
1919
| [![Apple logo](./../assets/moddable/mac-logo.png)](#mac) | [![Windows logo](./../assets/moddable/win-logo.png)](#win) | [![Linux logo](./../assets/moddable/lin-logo.png)](#lin) |
2020
| :--- | :--- | :--- |
2121
| • [Installing](#mac-instructions)<BR>• [Troubleshooting](#mac-troubleshooting) | • [Installing](#win-instructions)<BR>• [Troubleshooting](#win-troubleshooting) | • [Installing](#lin-instructions)<BR>• [Troubleshooting](#lin-troubleshooting)
22-
22+
2323
* [Using Zephyr Device Tree in JavaScript](#devicetree)
2424
* [Debugging Native Code](#debugging-native-code)
2525
* [Adding a new board](#new-board)
@@ -128,7 +128,7 @@ The Moddable SDK build uses Zephyr SDK v4.3 or later.
128128
west update
129129
```
130130

131-
9. The Zephyr west extension command, west packages can be used to install Python dependencies.
131+
9. Install Python dependencies using `west packages`.
132132

133133
```sh
134134
west packages pip --install
@@ -184,9 +184,9 @@ Other silicon families may have different requirements.
184184
1. Install the Moddable SDK tools by following the instructions in the [Getting Started document](./../Moddable%20SDK%20-%20Getting%20Started.md).
185185

186186
2. Install Zephyr for Windows by following the instructions in the Zephyr [Getting Started Guide](https://docs.zephyrproject.org/latest/develop/getting_started/index.html). A summary is presented below:
187-
187+
188188
> Note: Moddable tools use the CMD shell. When installing Zephyr from the instructions, choose the `Batchfile` instructions.
189-
189+
190190
3. Install Zephyr requirements:
191191

192192
```sh
@@ -212,9 +212,9 @@ Other silicon families may have different requirements.
212212
```sh
213213
zephyrproject\.venv\Scripts\activate.bat
214214
```
215-
215+
216216
> Note: You can deactivate the virtual environment by typing `deactivate` in your shell.
217-
217+
218218
7. Install the `west` tool:
219219

220220
```sh
@@ -249,7 +249,7 @@ Other silicon families may have different requirements.
249249
- Create a User Variable called `ZEPHYR_BASE` and set it to %USERPROFILE%\zephyrproject\zephyr
250250
- Variable name: `ZEPHYR_BASE`
251251
- Variable value (Use the "Browse Directory..." button to make this selection): `C:\Users\<user>\zephyrproject\zephyr`
252-
252+
253253
- Create a User Variable called `DEBUGGER_PORT`: the COM port for your device, e.g. `COM3`. This is used to connect your device to the `xsbug` JavaScript debugger.
254254

255255
To identify the correct serial port, launch the Windows Device Manager. Open the "Ports (COM & LPT)" section, verify the Serial port adapter is displayed, and note the associated COM port (e.g. COM3).
@@ -276,7 +276,6 @@ Other silicon families may have different requirements.
276276

277277
13. The device should connect to xsbug and stop at the `debugger` statement.
278278
> Note: Make sure you have built the Moddable tools in the Moddable Getting Started step.
279-
> Note: Make sure you have launched the `xsbug` debugger
280279

281280
<a id="lin"></a>
282281
## Linux
@@ -494,6 +493,8 @@ As with all Moddable platforms, you can debug script code using `xsbug` over the
494493
495494
For native code source level debugging, you can use [GDB](https://www.gnu.org/software/gdb/documentation/).
496495
496+
> Note: These instructions are for macOS and Linux.
497+
497498
Use the `-t debug` target to start the debugger:
498499
499500
```sh

0 commit comments

Comments
 (0)