Skip to content

Commit e5bf677

Browse files
obraper1234
andauthored
Grammar and formatting (#257)
* Grammar and formatting A couple minor tweaks to the README to (hopefully) make it a little bit clearer and easier to follow. Co-authored-by: per1234 <[email protected]>
1 parent d64ebc2 commit e5bf677

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

+21-9
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,50 @@ The repository contains the Arduino APIs and IDE integration files targeting a g
44

55
## Installation
66

7-
Clone the repository in `$sketchbook/hardware/arduino-git`
7+
### Clone the repository in `$sketchbook/hardware/arduino-git`
88

99
```bash
1010
mkdir -p $sketchbook/hardware/arduino-git
1111
cd $sketchbook/hardware/arduino-git
1212
git clone [email protected]:arduino/ArduinoCore-mbed mbed
1313
```
1414

15-
Then clone https://github.com/arduino/ArduinoCore-API in a directory at your choice.
15+
### Clone https://github.com/arduino/ArduinoCore-API into a directory of your choice.
1616

1717
```bash
1818
git clone [email protected]:arduino/ArduinoCore-API
1919
```
2020

21-
Remove the symlink to `api` you can find in `$sketchbook/hardware/arduino/mbed/cores/arduino` and replace it with a symlink to `ArduinoCore-API/api`
21+
### Update the `api` symlink
2222

23-
Open Arduino IDE; you should now see three new targets under `MBED boards` label
23+
Remove the symlink to `api` in `$sketchbook/hardware/arduino/mbed/cores/arduino` and replace it with a symlink to `ArduinoCore-API/api`.
24+
25+
### Test things out
26+
27+
Open the Arduino IDE.
28+
29+
You should now see three new targets under the `MBED boards` label.
30+
31+
*This procedure does not automatically install the required ARM compiler toolchain.*
32+
33+
If the toolchain is missing, you'll see errors like this when you try to build for an mbed-os enabled board.:
2434

25-
You may also need to install ARM build tools if you see an error like the following when you attempt to build for one of the mbed-os enabled boards.
2635
```
2736
fork/exec /bin/arm-none-eabi-g++: no such file or directory
2837
```
29-
The missing ARM build tools can be installed by using the `Boards Manager` option in the Arduino IDE to add the `Arduino mbed-enabled Boards` board package.
38+
To install ARM build tools, use the `Boards Manager` option in the Arduino IDE to add the `Arduino mbed-enabled Boards` package.
3039

3140

3241
## Adding an mbed target
3342

34-
Adding a target is a mostly automatic procedure that involves running https://github.com/arduino/ArduinoCore-mbed/blob/master/mbed-os-to-arduino after setting `BOARDNAME` and `ARDUINOCORE` env variables.
43+
Adding a target is a mostly automatic procedure that involves running https://github.com/arduino/ArduinoCore-mbed/blob/master/mbed-os-to-arduino after setting the `BOARDNAME` and `ARDUINOCORE` env variables.
3544
Actions marked as TODO must be executed manually.
3645

37-
**Minimum Example**: `./mbed-os-to-arduino -r /home/alex/projects/arduino/cores/mbed-os-h747 PORTENTA_H7_M7:PORTENTA_H7_M7`
46+
**Minimum Example**:
47+
```
48+
cd $sketchbook/hardware/arduino-git/mbed
49+
./mbed-os-to-arduino -r /home/alex/projects/arduino/cores/mbed-os-h747 PORTENTA_H7_M7:PORTENTA_H7_M7
50+
```
3851

3952
### How to build a debug version of the Arduino mbed libraries
4053
* Modify `mbed-os-to-arduino `
@@ -56,4 +69,3 @@ You can use this core as a standard mbed library; all APIs are under `arduino` n
5669

5770
The opposite is working as well; from any sketch you can call mbed APIs by prepending `mbed::` namespace.
5871

59-

0 commit comments

Comments
 (0)