From 57530006e70bb0a036a6a0123f4ade0c5de53fad Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 17:45:13 -0800 Subject: [PATCH 1/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 da8c2e016bc..14eac83b487 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,7 @@ +Several options are available for installation of Arduino CLI. Instructions for each are provided below: + ## Install via Homebrew (macOS/Linux) The Arduino CLI is available as a Homebrew formula since version `0.5.0`: From b0bdcfc4fffa3f8ff9a91be4c78a88feaa8c6700 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 17:45:48 -0800 Subject: [PATCH 2/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 14eac83b487..5067438d012 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -17,8 +17,9 @@ brew install arduino-cli ## 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 CLI to `$PWD/bin`: From 4d6cbb7fda0942ab6aa440e3f6d4191bea0d3f57 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 17:46:38 -0800 Subject: [PATCH 3/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 5067438d012..9a6d61b3b6d 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -34,7 +34,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install. ``` If you would like to use the `arduino-cli` command from any location, install Arduino CLI to a directory already in your -`PATH` or add the Arduino CLI installation path to your `PATH` environment variable. +[`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino CLI installation path to your `PATH` +environment variable. If you want to download a specific Arduino CLI version, for example `0.9.0` or `nightly-latest`, pass the version number as a parameter like this: @@ -52,7 +53,8 @@ Arduino CLI checks for new releases every 24 hours. If you don't like this behav Pre-built binaries for all the supported platforms are available for download from the links below. If you would like to use the `arduino-cli` command from any location, extract the downloaded file to a directory already -in your `PATH` or add the Arduino CLI installation path to your `PATH` environment variable. +in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino CLI installation path to your +`PATH` environment variable. #### Latest release From 1e34d47a8f7eaa302e05f84eaaf0ba9a7d549b29 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 17:47:18 -0800 Subject: [PATCH 4/4] Align heading levels in install docs This document is intended to provide a list of installation options: - brew - script - download - build but the heading levels were misaligned, which resulted in this structure: -brew - 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 9a6d61b3b6d..57297540c9e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -48,7 +48,7 @@ Arduino CLI checks for new releases every 24 hours. If you don't like this behav [`updater.enable_notification` config](configuration.md#configuration-keys) or the [env var `ARDUINO_UPDATER_ENABLE_NOTIFICATION`](configuration.md#environment-variables) to `false`. -### Download +## Download Pre-built binaries for all the supported platforms are available for download from the links below. @@ -56,7 +56,7 @@ If you would like to use the `arduino-cli` command from any location, extract th in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino CLI installation path to your `PATH` environment variable. -#### Latest release +### Latest release | Platform | | | | --------- | -------------------- | -------------------- | @@ -77,11 +77,11 @@ in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the > `http://downloads.arduino.cc/arduino-cli/arduino-cli-latest-.tar.bz2` won’t be further updated. That URL > will provide the version `0.3.7-alpha.preview`, regardless of further releases. -#### Previous versions +### Previous versions These are available from the "Assets" sections on the [releases page](https://github.com/arduino/arduino-cli/releases). -#### Nightly builds +### Nightly builds These builds are generated every day at 01:00 GMT from the `master` branch and should be considered unstable. In order to get the latest nightly build available for the supported platform, use the following links: @@ -107,7 +107,7 @@ to get the latest nightly build available for the supported platform, use the fo Checksums for the nightly builds are available at `https://downloads.arduino.cc/arduino-cli/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 CLI locally with your Go toolchain. See the ["How to contribute"](CONTRIBUTING.md#building-the-source-code) page for instructions.