Skip to content

Commit 847c7f9

Browse files
authored
Merge pull request #54 from v923z/readme
updated readme
2 parents 700e3ff + ab8b5fe commit 847c7f9

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# micropython-ulab
22

3-
ulab is a numpy-like array manipulation library for micropython and circuitpython.
4-
The module is written in C, defines compact containers for numerical
5-
data, and is fast.
3+
`ulab` is a `numpy`-like array manipulation library for micropython and circuitpython.
4+
The module is written in C, defines compact containers for numerical
5+
data, and is fast. The library is a software-only standard `micropython` user module,
6+
i.e., it has no hardware dependencies, and can be compiled for any platform.
7+
The `float` implementation of `micropython` (`float`, or `double`) is automatically detected.
68

7-
Documentation can be found under https://micropython-ulab.readthedocs.io/en/latest/
8-
The source for the manual is in https://github.com/v923z/micropython-ulab/blob/master/docs/ulab-manual.ipynb,
9-
while developer help is in https://github.com/v923z/micropython-ulab/blob/master/docs/ulab.ipynb.
9+
Documentation can be found under https://micropython-ulab.readthedocs.io/en/latest/.
1010

1111
# Firmware
1212

@@ -32,22 +32,23 @@ on the command line. This will create a new repository with the name `micropytho
3232
git clone https://github.com/v923z/micropython-ulab.git ulab
3333
```
3434

35-
If you don't have the cross-compiler installed, your might want to do that now, for instance on Linux by executing
35+
If you don't have the cross-compiler installed, your might want to do that now, for instance on Linux by executing
3636

3737
```
3838
sudo apt-get install gcc-arm-none-eabi
3939
```
4040

41-
If that was successful, you can try to run the make command in the port's directory as
41+
If this step was successful, you can try to run the `make` command in the port's directory as
4242
```
4343
make BOARD=PYBV11 USER_C_MODULES=../../../ulab all
4444
```
4545
which will prepare the firmware for pyboard.v.11. Similarly,
4646
```
4747
make BOARD=PYBD_SF6 USER_C_MODULES=../../../ulab all
4848
```
49-
will compile for the SF6 member of the PYBD series. Provided that you managed to compile the firmware, you would upload that by running
50-
either
49+
will compile for the SF6 member of the PYBD series. If your target is `unix`, you don't need to specify the `BOARD` parameter.
50+
51+
Provided that you managed to compile the firmware, you would upload that by running either
5152
```
5253
dfu-util --alt 0 -D firmware.dfu
5354
```

0 commit comments

Comments
 (0)