Skip to content

Commit 1243277

Browse files
authored
[skip changelog] Sync install docs from "template" (#1544)
* 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. * 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. * 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. * 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
1 parent 8cae880 commit 1243277

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/installation.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<!-- Source: https://github.com/arduino/tooling-project-assets/blob/main/other/installation-script/installation.md -->
22

3+
Several options are available for installation of Arduino CLI. Instructions for each are provided below:
4+
35
## Install via Homebrew (macOS/Linux)
46

57
The Arduino CLI is available as a Homebrew formula since version `0.5.0`:
@@ -15,8 +17,9 @@ brew install arduino-cli
1517

1618
## Use the install script
1719

18-
The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows. The
19-
script can be run on Windows by installing [Git for Windows](https://gitforwindows.org/), then running it from Git Bash.
20+
The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows,
21+
though it is available as part of [Git for Windows](https://gitforwindows.org/) (Git Bash). If you don't have `sh`
22+
available, use the ["Download" installation option](#download).
2023

2124
This script will install the latest version of Arduino CLI to `$PWD/bin`:
2225

@@ -31,7 +34,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.
3134
```
3235

3336
If you would like to use the `arduino-cli` command from any location, install Arduino CLI to a directory already in your
34-
`PATH` or add the Arduino CLI installation path to your `PATH` environment variable.
37+
[`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino CLI installation path to your `PATH`
38+
environment variable.
3539

3640
If you want to download a specific Arduino CLI version, for example `0.9.0` or `nightly-latest`, pass the version number
3741
as a parameter like this:
@@ -44,14 +48,15 @@ Arduino CLI checks for new releases every 24 hours. If you don't like this behav
4448
[`updater.enable_notification` config](configuration.md#configuration-keys) or the
4549
[env var `ARDUINO_UPDATER_ENABLE_NOTIFICATION`](configuration.md#environment-variables) to `false`.
4650

47-
### Download
51+
## Download
4852

4953
Pre-built binaries for all the supported platforms are available for download from the links below.
5054

5155
If you would like to use the `arduino-cli` command from any location, extract the downloaded file to a directory already
52-
in your `PATH` or add the Arduino CLI installation path to your `PATH` environment variable.
56+
in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino CLI installation path to your
57+
`PATH` environment variable.
5358

54-
#### Latest release
59+
### Latest release
5560

5661
| Platform | | |
5762
| --------- | -------------------- | -------------------- |
@@ -72,11 +77,11 @@ in your `PATH` or add the Arduino CLI installation path to your `PATH` environme
7277
> `http://downloads.arduino.cc/arduino-cli/arduino-cli-latest-<platform>.tar.bz2` won’t be further updated. That URL
7378
> will provide the version `0.3.7-alpha.preview`, regardless of further releases.
7479
75-
#### Previous versions
80+
### Previous versions
7681

7782
These are available from the "Assets" sections on the [releases page](https://github.com/arduino/arduino-cli/releases).
7883

79-
#### Nightly builds
84+
### Nightly builds
8085

8186
These builds are generated every day at 01:00 GMT from the `master` branch and should be considered unstable. In order
8287
to get the latest nightly build available for the supported platform, use the following links:
@@ -102,7 +107,7 @@ to get the latest nightly build available for the supported platform, use the fo
102107
Checksums for the nightly builds are available at
103108
`https://downloads.arduino.cc/arduino-cli/nightly/nightly-<DATE>-checksums.txt`
104109

105-
### Build from source
110+
## Build from source
106111

107112
If you're familiar with Golang or if you want to contribute to the project, you will probably build Arduino CLI locally
108113
with your Go toolchain. See the ["How to contribute"](CONTRIBUTING.md#building-the-source-code) page for instructions.

0 commit comments

Comments
 (0)