8000 Update README.md · adafruit/circuitpython-ulab@f2deb06 · GitHub
[go: up one dir, main page]

Skip to content

Commit f2deb06

Browse files
authored
Update README.md
1 parent 4a5d1e5 commit f2deb06

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,41 @@ while developer help is in https://github.com/v923z/micropython-ulab/blob/master
1010

1111
Firmware for pyboard.v.1.1 is updated once in a while, and can be downloaded
1212
from https://github.com/v923z/micropython-ulab/releases, otherwise, it can be
13-
compiled from the source by following the steps
14-
https://micropython-usermod.readthedocs.io/en/latest/usermods_05.html#compiling-our-module.
13+
compiled from the source by following these steps:
1514

15+
First, you have to clone the micropython repository by running
1616

17+
```
18+
git clone https://github.com/micropython/micropython.git
19+
```
20+
on the command line. This will create a new repository with the name `micropython`. Staying there, clone the `ulab` repository with
1721

22+
```
23+
git clone https://github.com/v923z/micropython-ulab.git
24+
```
25+
26+
Then you have to include `ulab` in the compilation process by editing `mpconfigport.h` of the directory of the port for which you want to compile, so, still on the command line, navigate to `micropython/ports/unix`, or `micropython/ports/stm32`, or whichever port is your favourite, and edit the `mpconfigport.h` file there. All you have to do is add a single line at the end:
27+
28+
```
29+
#define MODULE_ULAB_ENABLED (1)
30+
```
31+
32+
This line will inform the compiler that you want `ulab` in the resulting firmware. If you don't have the cross-compiler installed, your might want to do that now by executing
33+
34+
```
35+
sudo apt-get install gcc-arm-none-eabi
36+
```
37+
If that was successful, you can try to run the make command in the port's directory as
38+
```
39+
make BOARD=PYBV11 USER_C_MODULES=../../../ulab all
40+
```
41+
which will prepare the firmware for pyboard.v.11. Provided that you managed to compile the firmware, you would upload that either by running
42+
```
43+
dfu-util --alt 0 -D firmware.dfu
44+
```
45+
or
46+
```
47+
python pydfu.py -u firmware.dfu
48+
```
49+
50+
In case you got stuck somewhere in the process, a bit more detailed instructions can be found under https://github.com/micropython/micropython/wiki/Getting-Started, and https://github.com/micropython/micropython/wiki/Pyboard-Firmware-Update.

0 commit comments

Comments
 (0)
0