Skip to content

Commit f60eebf

Browse files
committed
Improve formatting of readme
1 parent 1e4038e commit f60eebf

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# arduino/compile-sketches action
1+
# `arduino/compile-sketches` action
22

33
[![Tests](https://github.com/arduino/compile-sketches/workflows/Test%20Python%20code/badge.svg)](https://github.com/arduino/compile-sketches/actions?workflow=Test+Python+code)
44
[![Lint](https://github.com/arduino/compile-sketches/workflows/Lint%20Python%20code/badge.svg)](https://github.com/arduino/compile-sketches/actions?workflow=Lint+Python+code)
@@ -40,39 +40,39 @@ platforms: |
4040
name: "arduino:samd"
4141
```
4242
43-
#### Sources:
43+
#### Supported platform sources:
4444
4545
##### Boards Manager
4646
4747
Keys:
48-
- `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.
5050
- **Default**: the latest version.
51-
- `source-url` - Boards Manager URL of the platform.
51+
- **`source-url`** - Boards Manager URL of the platform.
5252
- **Default**: Arduino's package index, which allows installation of all official platforms.
5353

5454
##### Local path
5555

5656
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`.
5959

6060
##### Repository
6161

6262
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.
6666
- **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.
6868
- **Default**: root of the repository.
6969

7070
##### Archive download
7171

7272
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.
7676
- **Default**: root folder of the archive.
7777

7878
### `libraries`
@@ -84,42 +84,42 @@ This causes the repository to be installed as a library. If there are no library
8484
8585
Libraries are installed under the Arduino user folder at `~/Arduino/libraries`.
8686

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.
8888

89-
#### Sources:
89+
#### Supported library sources:
9090

9191
##### Library Manager
9292

9393
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.
9696
- **Default**: the latest version.
9797

9898
##### Local path
9999

100100
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.
103103
- **Default**: the folder will be named according to the source repository or subfolder name.
104104

105105
##### Repository
106106

107107
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.
110110
- **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.
112112
- **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.
114114
- **Default**: named according to the source repository or subfolder name.
115115

116116
##### Archive download
117117

118118
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.
121121
- **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.
123123
- **Default**: named according to the source archive or subfolder name.
124124

125125
### `sketch-paths`

0 commit comments

Comments
 (0)