Skip to content

Commit 82f2f91

Browse files
committed
docs: Mention how to run tests on host with external modules
This works also on Mac OS
1 parent 61adcc8 commit 82f2f91

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

docs/developing.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,27 @@ Install Python packages
5050
pip install -r requirements.txt
5151
```
5252

53+
#### Run tests on PC using external modules build
5354

54-
#### Run tests on PC
55+
This runs tests by building the modules as external C modules,
56+
which bakes them into the firmware image/executable.
57+
58+
NOTE: Tested on Linux and Mac OS. Not tested on Windows Subsystem for Linux (WSL).
59+
60+
```
61+
make check_unix
62+
```
63+
64+
#### Run tests on PC using dynamic native modules
65+
66+
This runs tests by building as dynamic native modules (.mpy files),
67+
and the .mpy files are then loaded at runtime.
68+
69+
NOTE: This does not work on Mac OS. Due to https://github.com/micropython/micropython/issues/5500
5570

5671
NOTE: Requires `micropython` program to installed (MicroPython Unix port).
5772

58-
To build and run tests on host
73+
To build and run tests of dynamic native modules on host
5974
```
6075
make check
6176
```

0 commit comments

Comments
 (0)