From f2c3fe986f5325764da65c27332aad6787f41cf7 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 18:03:36 -0800 Subject: [PATCH 1/4] Align heading levels in install docs This document is intended to provide a list of installation options: - script - download - build but the heading levels were misaligned, which resulted in this structure: - script - download - build --- docs/installation.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 2dd46125..ef223dea 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -27,14 +27,14 @@ number as a parameter like this: curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/install.sh | sh -s 0.9.0 ``` -### Download +## Download Pre-built binaries for all the supported platforms are available for download from the links below. If you would like to use the `arduino-lint` command from any location, extract the downloaded file to a directory already in your `PATH` or add the Arduino Lint installation path to your `PATH` environment variable. -#### Latest release +### Latest release | Platform | | | | --------- | -------------------- | -------------------- | @@ -51,11 +51,11 @@ already in your `PATH` or add the Arduino Lint installation path to your `PATH` [windows32]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_Windows_32bit.zip [macos]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_macOS_64bit.tar.gz -#### Previous versions +### Previous versions These are available from the "Assets" sections on the [releases page](https://github.com/arduino/arduino-lint/releases). -#### Nightly builds +### Nightly builds These builds are generated every day at 01:00 GMT from the `main` branch and should be considered unstable. In order to get the latest nightly build available for the supported platform, use the following links: @@ -81,7 +81,7 @@ get the latest nightly build available for the supported platform, use the follo Checksums for the nightly builds are available at `https://downloads.arduino.cc/arduino-lint/nightly/nightly--checksums.txt` -### Build from source +## Build from source If you're familiar with Golang or if you want to contribute to the project, you will probably build Arduino Lint locally with your Go toolchain. See the ["How to contribute"](CONTRIBUTING.md#building-the-source-code) page for instructions. From 8bc7aab10fda2793151677f35f5497425efdd6b8 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 18:03:58 -0800 Subject: [PATCH 2/4] Add an introduction to install docs This document provides a list of installation options. The user may pick any one option that is most convenient for them. However, a reader might get the impression that it is a list of instructions that must be followed from top to bottom. An introduction makes the situation immediately clear to the reader. --- docs/installation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/installation.md b/docs/installation.md index ef223dea..504fbaf6 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,7 @@ +Several options are available for installation of Arduino Lint. Instructions for each are provided below: + ## Use the install script The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows. The From ed05a16562e341cc348d127c6066d73ab1b98764 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 18:04:20 -0800 Subject: [PATCH 3/4] Clarify that sh is not required in template install docs A significant portion of Arduino users use Windows. The first option listed in the installation instructions is for an installation shell script, which can be used on Windows, but might not be convenient for some Windows users. This could be discouraging or frustrating to potential new users, but not necessarily so because the script is an optional convenience and directly downloading and installing the tool is also an option, as documented in the instructions for the second listed option. A little refinement of the wording of the script's `sh` requirement makes the situation clear to those users. --- docs/installation.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 504fbaf6..4bfa31ba 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -4,8 +4,9 @@ Several options are available for installation of Arduino Lint. Instructions for ## Use the install script -The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows. The -script can be run on Windows by installing [Git for Windows](https://gitforwindows.org/), then running it from Git Bash. +The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows, +though it is available as part of [Git for Windows](https://gitforwindows.org/) (Git Bash). If you don't have `sh` +available, use the ["Download" installation option](#download). This script will install the latest version of Arduino Lint to `$PWD/bin`: From 12ac20521b23406ada69a0853bd094b865e36772 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 18:05:04 -0800 Subject: [PATCH 4/4] Add a reference link re: PATH to install docs A reference link provides easy access to the relevant information for readers who are not familiar with this concept while not harming readability for everyone else by increasing verbosity. --- docs/installation.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index 4bfa31ba..88c71423 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -21,7 +21,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/insta ``` If you would like to use the `arduino-lint` command from any location, install Arduino Lint to a directory already in -your `PATH` or add the Arduino Lint installation path to your `PATH` environment variable. +your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino Lint installation path to your +`PATH` environment variable. If you want to download a specific Arduino Lint version, for example `0.9.0` or `nightly-latest`, pass the version number as a parameter like this: @@ -35,7 +36,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/insta Pre-built binaries for all the supported platforms are available for download from the links below. If you would like to use the `arduino-lint` command from any location, extract the downloaded file to a directory -already in your `PATH` or add the Arduino Lint installation path to your `PATH` environment variable. +already in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino Lint installation path +to your `PATH` environment variable. ### Latest release