Skip to content

Commit ddaf0a0

Browse files
committed
Use real platforms in example
1 parent 195977b commit ddaf0a0

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

docs/platform-specification.md

+18-15
Original file line numberDiff line numberDiff line change
@@ -26,31 +26,34 @@ Alternatively, a platform may be manually installed by the user inside the Sketc
2626
- `{VENDOR_NAME}` is the identifier of the vendor/maintainer of the platform.
2727
- `{ARCHITECTURE}` is the architecture of the CPU used in the platform.
2828

29-
A vendor/maintainer can have multiple supported architectures.
29+
A vendor/maintainer may have multiple supported architectures.
3030

31-
For example, below we have four platforms downloaded from three hypothetical hardware vendors called "arduino", "foo"
32-
and "bar", and installed using the Board Manager:
31+
Let's see an example, below we have a bunch of platforms downloaded from three hardware vendors `arduino`, `adafruit`
32+
and `esp32`, and installed using the Board Manager:
3333

3434
```
35-
{directories.data}/packages/arduino/hardware/avr/1.2.3/...
36-
{directories.data}/packages/arduino/hardware/sam/1.4.5/...
37-
{directories.data}/packages/foo/hardware/avr/1.0.2/...
38-
{directories.data}/packages/bar/hardware/avr/1.1.0/...
35+
{directories.data}/packages/arduino/hardware/avr/1.8.6/...
36+
{directories.data}/packages/arduino/hardware/esp32/2.0.18-arduino.5/...
37+
{directories.data}/packages/arduino/hardware/nrf52/1.4.5/...
38+
{directories.data}/packages/adafruit/hardware/nrf52/1.6.1/...
39+
{directories.data}/packages/esp32/hardware/esp32/3.0.7/...
3940
```
4041

41-
If the same platform were manually installed by the user, he should have unpacked them inside the following directories:
42+
In this example three architectures have been installed from the vendor `arduino` (`avr`, `esp32` and `nrf52`), and one
43+
from `adafruit` and `esp32` (`nrf52` and `esp32` respectively). Note that the vendor `esp32` has the same name of the
44+
architecture `esp32`.
45+
46+
If the user manually installed the same platforms, they should have unpacked them in the following directories:
4247

4348
```
4449
{directories.user}/hardware/arduino/avr/...
45-
{directories.user}/hardware/arduino/sam/...
46-
{directories.user}/hardware/foo/avr/...
47-
{directories.user}/hardware/bar/avr/...
50+
{directories.user}/hardware/arduino/esp32/...
51+
{directories.user}/hardware/arduino/nrf52/...
52+
{directories.user}/hardware/adafruit/nrf52/...
53+
{directories.user}/hardware/esp32/esp32/...
4854
```
4955

50-
In this latter case the version is omitted.
51-
52-
We can also see that the vendor "arduino" has two supported architectures (AVR and SAM), while "foo" and "bar" have only
53-
AVR.
56+
In this latter case the version must be omitted.
5457

5558
### Notes about choosing the architecture name
5659

0 commit comments

Comments
 (0)