Skip to content

Improve documentation #6

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 12 commits into from
Sep 15, 2020
Merged

Improve documentation #6

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
dbc79b7
Add badges to readme to indicate CI status
per1234 Sep 11, 2020
bc91ec5
Correct branch name shown in example snippets in readme
per1234 Sep 11, 2020
1e4038e
Format the documentation to make default input values easy to find
per1234 Sep 11, 2020
f60eebf
Improve formatting of readme
per1234 Sep 11, 2020
f9a7a52
Linkify readme text where appropriate to provide easy access to suppo…
per1234 Sep 11, 2020
6b42c37
Add example of platform name in documentation of inputs
per1234 Sep 11, 2020
6cb375a
Remove unnecessary conditional from example workflow snippet
per1234 Sep 13, 2020
87fad66
Add line breaks to documentation to improve readability
per1234 Sep 13, 2020
040a3f4
Provide a detailed explanation of how the deltas report is produced
per1234 Sep 13, 2020
061d56d
Document that automated library dependencies are installed
per1234 Sep 13, 2020
e8780d2
Add table of contents to readme
per1234 Sep 14, 2020
98519b3
Remove off-topic example from readme
per1234 Sep 14, 2020
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
Prev Previous commit
Next Next commit
Improve formatting of readme
  • Loading branch information
@per1234
per1234 committed Sep 11, 2020
commit f60eebf6f299a66b1ab1a96952a6d2be475e548b
54 changes: 27 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# arduino/compile-sketches action
# `arduino/compile-sketches` action

[![Tests](https://github.com/arduino/compile-sketches/workflows/Test%20Python%20code/badge.svg)](https://github.com/arduino/compile-sketches/actions?workflow=Test+Python+code)
[![Lint](https://github.com/arduino/compile-sketches/workflows/Lint%20Python%20code/badge.svg)](https://github.com/arduino/compile-sketches/actions?workflow=Lint+Python+code)
Expand Down Expand Up @@ -40,39 +40,39 @@ platforms: |
name: "arduino:samd"
```

#### Sources:
#### Supported platform sources:

##### Boards Manager

Keys:
- `name` - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
- `version` - version of the platform to install.
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
- **`version`** - version of the platform to install.
- **Default**: the latest version.
- `source-url` - Boards Manager URL of the platform.
- **`source-url`** - Boards Manager URL of the platform.
- **Default**: Arduino's package index, which allows installation of all official platforms.

##### Local path

Keys:
- `source-path` - (**required**) path to install as a platform. Relative paths are assumed to be relative to the root of the repository.
- `name` - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
- **`source-path`** - (**required**) path to install as a platform. Relative paths are assumed to be relative to the root of the repository.
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.

##### Repository

Keys:
- `source-url` - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
- `name` - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
- `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.
- **`source-url`** - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
- **`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.
- **Default**: the repository is checked out to the tip of the default branch.
- `source-path` - path to install as a platform. Paths are relative to the root of the repository.
- **`source-path`** - path to install as a platform. Paths are relative to the root of the repository.
- **Default**: root of the repository.

##### Archive download

Keys:
- `source-url` - (**required**) download URL for the archive (e.g., `https://github.com/arduino/ArduinoCore-avr/archive/master.zip`).
- `name` - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
- `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.
- **`source-url`** - (**required**) download URL for the archive (e.g., `https://github.com/arduino/ArduinoCore-avr/archive/master.zip`).
- **`name`** - (**required**) platform name in the form of `VENDOR:ARCHITECTURE`.
- **`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.
- **Default**: root folder of the archive.

### `libraries`
Expand All @@ -84,42 +84,42 @@ This causes the repository to be installed as a library. If there are no library

Libraries are installed under the Arduino user folder at `~/Arduino/libraries`.

Note: when the deprecated space-separated list format of this input is used, the repository under test will always be installed as a library.
**Note**: when the deprecated space-separated list format of this input is used, the repository under test will always be installed as a library.

#### Sources:
#### Supported library sources:

##### Library Manager

Keys:
- `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 `_`.
- `version` - version of the library to install.
- **`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 `_`.
- **`version`** - version of the library to install.
- **Default**: the latest version.

##### Local path

Keys:
- `source-path` - (**required**) path to install as a library. Relative paths are assumed to be relative to the root of the repository.
- `destination-name` - folder name to install the library to.
- **`source-path`** - (**required**) path to install as a library. Relative paths are assumed to be relative to the root of the repository.
- **`destination-name`** - folder name to install the library to.
- **Default**: the folder will be named according to the source repository or subfolder name.

##### Repository

Keys:
- `source-url` - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
- `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.
- **`source-url`** - (**required**) URL to clone the repository from. It must start with `git://` or end with `.git`.
- **`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.
- **Default**: the tip of the default branch.
- `source-path` - path to install as a library. Paths are relative to the root of the repository.
- **`source-path`** - path to install as a library. Paths are relative to the root of the repository.
- **Default**: root of the repository.
- `destination-name` - folder name to install the library to.
- **`destination-name`** - folder name to install the library to.
- **Default**: named according to the source repository or subfolder name.

##### Archive download

Keys:
- `source-url` - (**required**) download URL for the archive (e.g., `https://github.com/arduino-libraries/Servo/archive/master.zip`).
- `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.
- **`source-url`** - (**required**) download URL for the archive (e.g., `https://github.com/arduino-libraries/Servo/archive/master.zip`).
- **`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.
- **Default**: root folder of the archive.
- `destination-name` - folder name to install the library to.
- **`destination-name`** - folder name to install the library to.
- **Default**: named according to the source archive or subfolder name.

### `sketch-paths`
Expand Down