Merge pull request #68 from per1234/fix-compile-examples-readme

libraries/compile-examples: fix errors in readme

Author: aentinger

README.md

@@ -1,12 +1,12 @@
 # libraries/compile-examples action
 
-This action compiles all of the examples contained in the library.
+This action checks whether Arduino sketches compile and produces a report of data from the compilations.
 
 ## Inputs
 
 ### `cli-version`
 
-The version of `arduino-cli` to use. Default `"latest"`.
+The version of [Arduino CLI](https://github.com/arduino/arduino-cli) to use. Default `"latest"`.
 
 ### `fqbn`
 
@@ -20,13 +20,13 @@ For 3rd party boards, also specify the Boards Manager URL:
 
 YAML-format list of platform dependencies to install.
 
-Default `""`. If no `platforms` input is provided, the board's dependency will be automatically determined from the `fqbn` input and the latest version of that platform will be installed via Board Manager.
+Default `""`. If no `platforms` input is provided, the board's dependency will be automatically determined from the `fqbn` input and the latest version of that platform will be installed via Boards Manager.
 
-If a platform dependency from a non-Board Manager source of the same name as another Board Manager source platform dependency is defined, they will both be installed, with the non-Board Manager dependency overwriting the Board Manager platform installation. This permits testing against a non-release version of a platform while using Board Manager to install the platform's tools dependencies.
+If a platform dependency from a non-Boards Manager source of the same name as another Boards Manager source platform dependency is defined, they will both be installed, with the non-Boards Manager dependency overwriting the Boards Manager platform installation. This permits testing against a non-release version of a platform while using Boards Manager to install the platform's tools dependencies.
 Example:
 ```yaml
 platforms: |
-  # Install the latest release of Arduino SAMD Boards and its toolchain via Board Manager
+  # Install the latest release of Arduino SAMD Boards and its toolchain via Boards Manager
   - name: "arduino:samd"
   # Install the platform from the root of the repository, replacing the BM installed platform
   - source-path: "."
@@ -35,11 +35,12 @@ platforms: |
 
 #### Sources:
 
-##### Board Manager
+##### Boards Manager
 
 Keys:
 - `name` - platform name in the form of `VENDOR:ARCHITECTURE`.
 - `version` - version of the platform to install. Default is the latest version.
+- `source-url` - Boards Manager URL of the platform. Default is Arduino's package index, which allows installation of all official platforms.
 
 ##### Local path
 
@@ -52,14 +53,14 @@ Keys:
 Keys:
 - `source-url` - 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. By default, the repository will be checked out to the tip of the default branch.
-- `source-path` - path to install as a library. Paths are relative to the root of the repository. The default is to install from the root of the repository.
+- `source-path` - path to install as a platform. Paths are relative to the root of the repository. The default is to install from the root of the repository.
 - `name` - platform name in the form of `VENDOR:ARCHITECTURE`.
 
 ##### Archive download
 
 Keys:
 - `source-url` - download URL for the archive (e.g., `https://github.com/arduino/ArduinoCore-avr/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. The default is to install from the root folder of the archive.
+- `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. The default is to install from the root folder of the archive.
 - `name` - platform name in the form of `VENDOR:ARCHITECTURE`.
 
 ### `libraries`
@@ -77,7 +78,7 @@ Note: the original space-separated list format is also supported. When this synt
 ##### Library Manager
 
 Keys:
-- `name` - name of the library, as defined in the `name` field of its [library.properties](https://arduino.github.io/arduino-cli/library-specification/#libraryproperties-file-format) metadata file. The library will be installed to a folder matching the name, but with any spaces replaced by `_`.
+- `name` - 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 is the latest version.
 
 ##### Local path
@@ -111,11 +112,11 @@ Set to true to show verbose output in the log. Default `false`
 
 ### `sketches-report-path`
 
-Path in which to save a JSON formatted file containing data from the sketch compilations. Should be used only to store reports. Relative paths are relative to [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. This report is used by the `arduino/libraries/report-size-deltas` and `arduino/libraries/report-size-trends` actions. Default `"size-deltas-reports"`.
+Path in which to save a JSON formatted file containing data from the sketch compilations. Should be used only to store reports. Relative paths are relative to [`GITHUB_WORKSPACE`](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables). The folder will be created if it doesn't already exist. This report is used by the `arduino/actions/libraries/report-size-deltas` and `arduino/actions/libraries/report-size-trends` actions. Default `"size-deltas-reports"`.
 
 ### `github-token`
 
-GitHub access token used to get information from the GitHub API. Only needed if you're using the size report features with private repositories. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.
+GitHub access token used to get information from the GitHub API. Only needed for private repositories with `enable-size-deltas-report` set to `true`. It will be convenient to use [`${{ secrets.GITHUB_TOKEN }}`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token). Default `""`.
 
 ### `enable-size-deltas-report`