Skip to content

Updated and refined documentation #2760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 27, 2024
Merged

Updated and refined documentation #2760

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b744f86
Cleared usage of identification properties
cmaglie Nov 20, 2024
bd3c784
Expanded docs on default directories configuration
cmaglie Nov 21, 2024
dbd2498
Refined platform specification on installation folder for platforms
cmaglie Nov 21, 2024
195977b
Apply suggestions from code review
cmaglie Nov 21, 2024
ddaf0a0
Use real platforms in example
cmaglie Nov 25, 2024
ab0cbe4
Apply code review suggestions
cmaglie Nov 27, 2024
f250df9
Fixed doc formatting, after upgrade of 'prettier'
cmaglie Nov 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 18 additions & 15 deletions docs/platform-specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,31 +26,34 @@ Alternatively, a platform may be manually installed by the user inside the Sketc
- `{VENDOR_NAME}` is the identifier of the vendor/maintainer of the platform.
- `{ARCHITECTURE}` is the architecture of the CPU used in the platform.

A vendor/maintainer can have multiple supported architectures.
A vendor/maintainer may have multiple supported architectures.

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

```
{directories.data}/packages/arduino/hardware/avr/1.2.3/...
{directories.data}/packages/arduino/hardware/sam/1.4.5/...
{directories.data}/packages/foo/hardware/avr/1.0.2/...
{directories.data}/packages/bar/hardware/avr/1.1.0/...
{directories.data}/packages/arduino/hardware/avr/1.8.6/...
{directories.data}/packages/arduino/hardware/esp32/2.0.18-arduino.5/...
{directories.data}/packages/arduino/hardware/nrf52/1.4.5/...
{directories.data}/packages/adafruit/hardware/nrf52/1.6.1/...
{directories.data}/packages/esp32/hardware/esp32/3.0.7/...
```

If the same platform were manually installed by the user, he should have unpacked them inside the following directories:
In this example three architectures have been installed from the vendor `arduino` (`avr`, `esp32` and `nrf52`), and one
from `adafruit` and `esp32` (`nrf52` and `esp32` respectively). Note that the vendor `esp32` has the same name of the
architecture `esp32`.

If the user manually installed the same platforms, they should have unpacked them in the following directories:

```
{directories.user}/hardware/arduino/avr/...
{directories.user}/hardware/arduino/sam/...
{directories.user}/hardware/foo/avr/...
{directories.user}/hardware/bar/avr/...
{directories.user}/hardware/arduino/esp32/...
{directories.user}/hardware/arduino/nrf52/...
{directories.user}/hardware/adafruit/nrf52/...
{directories.user}/hardware/esp32/esp32/...
```

In this latter case the version is omitted.

We can also see that the vendor "arduino" has two supported architectures (AVR and SAM), while "foo" and "bar" have only
AVR.
In this latter case the version must be omitted.

### Notes about choosing the architecture name

Expand Down