Skip to content

Commit 7cb8858

Browse files
committed
README: Improve build instructions for developers
1 parent bd84916 commit 7cb8858

1 file changed

Lines changed: 23 additions & 5 deletions

File tree

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,16 +80,34 @@ git clone https://github.com/emlearn/emlearn-micropython
8080
```
8181

8282
#### Prerequisites
83-
These come in addition to the prequisites described above.
8483

85-
Make sure you have the dependencies needed to build for your platform.
86-
See [MicroPython: Building native modules](https://docs.micropython.org/en/latest/develop/natmod.html).
84+
You will need to have **Python 3.10+ or later** already installed.
8785

88-
We assume that micropython is installed in the same place as this repository.
86+
We assume that **micropython** git repository available.
87+
It is assumed to be at the same level as this repository in the file system.
8988
If using another location, adjust `MPY_DIR` accordingly.
90-
9189
You should be using MicroPython 1.25 (or newer).
9290

91+
Make sure you have the **build toolchain** needed for your platform.
92+
See [MicroPython: Building native modules](https://docs.micropython.org/en/latest/develop/natmod.html),
93+
and the documentation for the MicroPython port/architecture of interest.
94+
95+
#### Download dependencies
96+
97+
Fetch git submodules
98+
99+
```
100+
git submodule update --init
101+
```
102+
103+
Recommend using a Python virtual environment.
104+
105+
Install Python packages
106+
```
107+
pip install -r requirements.txt
108+
```
109+
110+
93111
#### Build
94112

95113
Build the .mpy native module

0 commit comments

Comments
 (0)