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
Copy file name to clipboardExpand all lines: docs/sketch-profiles.md
+9-9Lines changed: 9 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -30,23 +30,23 @@ profiles:
30
30
- <LIB_NAME> (<LIB_VERSION>)
31
31
- <LIB_NAME> (<LIB_VERSION>)
32
32
33
-
...more profiles here...
33
+
...more profiles here...
34
34
```
35
35
36
-
There is a 'profiles:' section containing all the profiles. Each field is self-explanatory, in particular:
36
+
There is an optional `profiles:` section containing all the profiles. Each field in a profile is mandatory (unless noted otherwise below). The available fields are:
37
37
38
38
-`<PROFILE_NAME>` is the profile identifier, it’s a user-defined field, and the allowed characters are alphanumerics,
39
-
underscore `_`, dot `.`, and dash `-`
40
-
-`<PLATFORM>` is the target core platform identifier, for example, `arduino:avr` or `adafruit:samd`
41
-
-`<PLATFORM_VERSION>` is the target core platform version required
39
+
underscore `_`, dot `.`, and dash `-`.
40
+
-`<PLATFORM>` is the target core platform identifier, for example, `arduino:avr` or `adafruit:samd`.
41
+
-`<PLATFORM_VERSION>` is the target core platform version required.
42
42
-`<3RD_PARTY_PLATFORM_URL>` is the index URL to download the target core platform (also known as “Additional Boards
43
43
Manager URLs” in the Arduino IDE). This field can be omitted for the official `arduino:*` platforms.
44
44
-`<PLATFORM_DEPENDENCY>`, `<PLATFORM_DEPENDENCY_VERSION>`, and `<3RD_PARTY_PLATFORM_DEPENDENCY_URL>` contains the same
45
-
information as `<PLATFORM>`, `<PLATFORM_VERSION>`, and `<3RD_PARTY_PLATFORM_URL>` but for the core platform dependency
45
+
information as `<PLATFORM>`, `<PLATFORM_VERSION>`, and `<3RD_PARTY_PLATFORM_URL>`respectively but for the core platform dependency
46
46
of the main core platform. These fields are optional.
47
-
-`<LIB_VERSION>` is the version required for the library, for example, `1.0.0`
48
-
-`<USER_NOTES>` is a free text string available to the developer to add comments
49
-
-`<DEFAULT_PROFILE_NAME>` is the profile used by default (more on that later)
47
+
-`libraries:` is a section where the required libraries to build the project are defined. This section is optional.
48
+
-`<LIB_VERSION>` is the version required for the library, for example, `1.0.0`.
49
+
-`<USER_NOTES>` is a free text string available to the developer to add comments.
50
50
51
51
A complete example of a `sketch.yaml` may be the following:
0 commit comments