Skip to content

Commit 6026d38

Browse files
committed
docs: Cross-link developing and contribution
1 parent 95db08c commit 6026d38

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This is a volunteer-driven hobby project and we welcome contributions.
1313

1414
## Developing
1515

16-
See [developing.md](./developing.md)
16+
See [developing.md](https://github.com/emlearn/emlearn-micropython/blob/master/docs/developing.md)
1717

1818
## Guidelines for Pull Requests
1919

docs/developing.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
For those that wish to hack on emlearn-micropython itself.
55

6+
Contribution guidelines can be found in [CONTRIBUTING.md](CONTRIBUTING.md).
7+
68
If you just wish to use it as a library, see instead the [usage guide](https://emlearn-micropython.readthedocs.io/en/latest/user_guide.html).
79

810
#### Prerequisites
@@ -18,11 +20,13 @@ It is assumed to be at the same level as this repository in the file system.
1820
If using another location, adjust `MPY_DIR` accordingly.
1921
You should be using MicroPython 1.25 (or newer).
2022

21-
Make sure you have the **build toolchain** needed for your platform.
23+
You should build and install the [MicroPython Unix port](https://github.com/micropython/micropython/blob/master/ports/unix/README.md) to run/test on PC (`micropython` executable).
24+
25+
To build and test on device, make sure you have the **build toolchain** needed for your hardware platform.
2226
See [MicroPython: Building native modules](https://docs.micropython.org/en/latest/develop/natmod.html),
2327
and the documentation for the MicroPython port/architecture of interest.
28+
For example `esp32`, `stm32` or `rp2`.
2429

25-
For example the [MicroPython Unix port](https://github.com/micropython/micropython/blob/master/ports/unix/README.md) to run/test on PC.
2630

2731
#### Download the code
2832

0 commit comments

Comments
 (0)