Skip to content

Commit 6b42c37

Browse files
committed
Add example of platform name in documentation of inputs
Even though the generic form was already provided, people who only use the IDEs will not necessarily be familiar with this notation.
1 parent f9a7a52 commit 6b42c37

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ platforms: |
4545
##### Boards Manager
4646
4747
Keys:
48-
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
48+
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
4949
- **`version`** - version of the platform to install.
5050
- **Default**: the latest version.
5151
- **`source-url`** - Boards Manager URL of the platform.
@@ -55,13 +55,13 @@ Keys:
5555

5656
Keys:
5757
- **`source-path`** - (**required**) path to install as a platform. Relative paths are assumed to be relative to the root of the repository.
58-
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
58+
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
5959

6060
##### Repository
6161

6262
Keys:
6363
- **`source-url`** - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
64-
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
64+
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
6565
- **`version`** - [Git ref](https://git-scm.com/book/en/v2/Git-Internals-Git-References) of the repository to checkout. The special version name `latest` will cause the latest tag to be used.
6666
- **Default**: the repository is checked out to the tip of the default branch.
6767
- **`source-path`** - path to install as a platform. Paths are relative to the root of the repository.
@@ -71,7 +71,7 @@ Keys:
7171

7272
Keys:
7373
- **`source-url`** - (**required**) download URL for the archive (e.g., `https://github.com/arduino/ArduinoCore-avr/archive/master.zip`).
74-
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
74+
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE` (e.g., `arduino:avr`).
7575
- **`source-path`** - path to install as a platform. Paths are relative to the root folder of the archive, or the root of the archive if it has no root folder.
7676
- **Default**: root folder of the archive.
7777

0 commit comments

Comments
 (0)