Skip to content

Commit 1587cae

Browse files
facchinmper1234
andcommitted
Update README.md
Co-authored-by: per1234 <[email protected]>
1 parent 33b5b28 commit 1587cae

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ To install ARM build tools, use the `Boards Manager` option in the Arduino IDE t
3939

4040
## mbed-os-to-arduino script
4141

42-
The backbone of the packaging process is https://github.com/arduino/ArduinoCore-mbed/blob/master/mbed-os-to-arduino script. It basically compiles a blank mbed-os project for any supported target board, recovering the files that will be needed at compile time and copying them to the right location.
42+
The backbone of the packaging process is the https://github.com/arduino/ArduinoCore-mbed/blob/master/mbed-os-to-arduino script. It basically compiles a blank Mbed OS project for any supported target board, recovering the files that will be needed at compile time and copying them to the right location.
4343

4444
It can be used for a variety of tasks including:
4545

46-
**Recompiling libmbed with source level debug support**
46+
### Recompiling libmbed with source level debug support
4747

4848
```
4949
cd $sketchbook/hardware/arduino-git/mbed
@@ -52,7 +52,7 @@ cd $sketchbook/hardware/arduino-git/mbed
5252

5353
In this case `-a` applies all the patches from `patches` folder into a mainline `mbed-os` tree, and `-g` restores the debug info.
5454

55-
**Selecting a different optimization profile**
55+
### Selecting a different optimization profile
5656

5757
```
5858
cd $sketchbook/hardware/arduino-git/mbed
@@ -61,7 +61,7 @@ PROFILE=release ./mbed-os-to-arduino -a NANO_RP2040_CONNECT:NANO_RP2040_CONNECT
6161

6262
The `PROFILE` environment variable tunes the compilation profiles (defaults to `DEVELOP`). Other available profiles are `DEBUG` and `RELEASE`.
6363

64-
**Selecting a different mbed-os tree**
64+
### Selecting a different Mbed OS tree
6565

6666
```
6767
cd $sketchbook/hardware/arduino-git/mbed
@@ -70,11 +70,11 @@ cd $sketchbook/hardware/arduino-git/mbed
7070

7171
`-r` flag allows using a custom `mbed-os` fork in place of the mainline one; useful during new target development.
7272

73-
**Adding a new target (variant)**
73+
### Adding a new target ([core variant](https://arduino.github.io/arduino-cli/latest/platform-specification/#core-variants))
7474

7575
Adding a target is a mostly automatic procedure.
7676

77-
For boards already supported by `mbed-os` , the bare minimum is
77+
For boards already supported by Mbed OS, the bare minimum is:
7878

7979
```
8080
cd $sketchbook/hardware/arduino-git/mbed
@@ -85,10 +85,10 @@ mkdir -p variants/$ALREADY_SUPPORTED_BOARD_NAME/{libs,conf}
8585
# ./mbed-os-to-arduino LPC546XX:LPC546XX
8686
```
8787

88-
This will produce almost all the files needed. To complete the port, add the board specifications to `boards.txt` (giving it an unique name) and provide `pins_arduino.h` and `variants.cpp` in `variants/$ALREADY_SUPPORTED_BOARD_NAME` folder.
88+
This will produce almost all the files needed. To complete the port, add the board specifications to [`boards.txt`](https://arduino.github.io/arduino-cli/latest/platform-specification/#boardstxt) (giving it a unique ID) and provide `pins_arduino.h` and `variants.cpp` in `variants/$ALREADY_SUPPORTED_BOARD_NAME` folder.
8989
Feel free to take inspirations from the existing variants :)
9090

91-
For boards not supported by mainline `mbed-os`, the same applies but you should provide the path of your `mbed-os` fork
91+
For boards not supported by mainline Mbed OS, the same applies but you should provide the path of your Mbed OS fork
9292

9393
```
9494
cd $sketchbook/hardware/arduino-git/mbed

0 commit comments

Comments
 (0)