You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- `name` - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
49
-
- `version`- version of the platform to install.
48
+
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
49
+
- **`version`** - version of the platform to install.
50
50
- **Default**: the latest version.
51
-
- `source-url`- Boards Manager URL of the platform.
51
+
- **`source-url`** - Boards Manager URL of the platform.
52
52
- **Default**: Arduino's package index, which allows installation of all official platforms.
53
53
54
54
##### Local path
55
55
56
56
Keys:
57
-
- `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`.
57
+
- **`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`.
59
59
60
60
##### Repository
61
61
62
62
Keys:
63
-
- `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`.
65
-
- `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.
63
+
- **`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`.
65
+
- **`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.
66
66
- **Default**: the repository is checked out to the tip of the default branch.
67
-
- `source-path`- path to install as a platform. Paths are relative to the root of the repository.
67
+
- **`source-path`** - path to install as a platform. Paths are relative to the root of the repository.
68
68
- **Default**: root of the repository.
69
69
70
70
##### Archive download
71
71
72
72
Keys:
73
-
- `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`.
75
-
- `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.
73
+
- **`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`.
75
+
- **`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.
76
76
- **Default**: root folder of the archive.
77
77
78
78
### `libraries`
@@ -84,42 +84,42 @@ This causes the repository to be installed as a library. If there are no library
84
84
85
85
Libraries are installed under the Arduino user folder at `~/Arduino/libraries`.
86
86
87
-
Note: when the deprecated space-separated list format of this input is used, the repository under test will always be installed as a library.
87
+
**Note**: when the deprecated space-separated list format of this input is used, the repository under test will always be installed as a library.
88
88
89
-
#### Sources:
89
+
#### Supported library sources:
90
90
91
91
##### Library Manager
92
92
93
93
Keys:
94
-
- `name`- (**required**) name of the library, as defined in the `name` field of its [library.properties](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format) metadata file. The library will be installed to a folder matching the name, but with any spaces replaced by `_`.
95
-
- `version`- version of the library to install.
94
+
- **`name`** - (**required**) name of the library, as defined in the `name` field of its [library.properties](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format) metadata file. The library will be installed to a folder matching the name, but with any spaces replaced by `_`.
95
+
- **`version`** - version of the library to install.
96
96
- **Default**: the latest version.
97
97
98
98
##### Local path
99
99
100
100
Keys:
101
-
- `source-path`- (**required**) path to install as a library. Relative paths are assumed to be relative to the root of the repository.
102
-
- `destination-name`- folder name to install the library to.
101
+
- **`source-path`** - (**required**) path to install as a library. Relative paths are assumed to be relative to the root of the repository.
102
+
- **`destination-name`** - folder name to install the library to.
103
103
- **Default**: the folder will be named according to the source repository or subfolder name.
104
104
105
105
##### Repository
106
106
107
107
Keys:
108
-
- `source-url`- (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
109
-
- `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.
108
+
- **`source-url`** - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
109
+
- **`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.
110
110
- **Default**: the tip of the default branch.
111
-
- `source-path`- path to install as a library. Paths are relative to the root of the repository.
111
+
- **`source-path`** - path to install as a library. Paths are relative to the root of the repository.
112
112
- **Default**: root of the repository.
113
-
- `destination-name`- folder name to install the library to.
113
+
- **`destination-name`** - folder name to install the library to.
114
114
- **Default**: named according to the source repository or subfolder name.
115
115
116
116
##### Archive download
117
117
118
118
Keys:
119
-
- `source-url`- (**required**) download URL for the archive (e.g., `https://github.com/arduino-libraries/Servo/archive/master.zip`).
120
-
- `source-path`- path to install as a library. Paths are relative to the root folder of the archive, or the root of the archive if it has no root folder.
119
+
- **`source-url`** - (**required**) download URL for the archive (e.g., `https://github.com/arduino-libraries/Servo/archive/master.zip`).
120
+
- **`source-path`** - path to install as a library. Paths are relative to the root folder of the archive, or the root of the archive if it has no root folder.
121
121
- **Default**: root folder of the archive.
122
-
- `destination-name`- folder name to install the library to.
122
+
- **`destination-name`** - folder name to install the library to.
123
123
- **Default**: named according to the source archive or subfolder name.
0 commit comments