File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -7,6 +7,10 @@ If you just wish to use it as a library, see instead the [usage guide](https://e
77
88#### Prerequisites
99
10+ These instructions have been tested on Linux.
11+ They might also work on Mac OS.
12+ For Windows, I recommend using Windows Subsystem for Linux (WSL2).
13+
1014You will need to have ** Python 3.10+ or later** already installed.
1115
1216We assume that ** micropython** git repository available.
@@ -18,6 +22,8 @@ Make sure you have the **build toolchain** needed for your platform.
1822See [ MicroPython: Building native modules] ( https://docs.micropython.org/en/latest/develop/natmod.html ) ,
1923and the documentation for the MicroPython port/architecture of interest.
2024
25+ For example the [ MicroPython Unix port] ( https://github.com/micropython/micropython/blob/master/ports/unix/README.md ) to run/test on PC.
26+
2127#### Download the code
2228
2329Clone the repository using git
@@ -43,6 +49,8 @@ pip install -r requirements.txt
4349
4450#### Run tests on PC
4551
52+ NOTE: Requires ` micropython ` program to installed (MicroPython Unix port).
53+
4654To build and run tests on host
4755```
4856make check
@@ -51,6 +59,9 @@ make check
5159
5260#### Build for device
5361
62+ NOTE: Requires the toolchain for the particular device to be installed.
63+ See MicroPython documentation for the port in-question.
64+
5465Build the .mpy native module
5566```
5667make dist ARCH=armv6m MPY_DIR=../micropython
You can’t perform that action at this time.
0 commit comments