Skip to content

Commit dc83887

Browse files
author
Massimiliano Pippi
authored
[skip-changelog] Reformat install instructions (#444)
* fix install instructions * [ci skip] fix header
1 parent 0f6d897 commit dc83887

File tree

1 file changed

+29
-23
lines changed

1 file changed

+29
-23
lines changed

README.md

+29-23
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,24 @@ build the source code, run the tests, and contribute your changes to the project
2020

2121
## How to install
2222

23-
### macOS/Linux installation via Homebrew
23+
### Get the latest package
2424

25-
The arduino-cli is available as a brew formula since version `0.5.0`:
26-
```
25+
You have several options to install the latest version of the Arduino CLI
26+
on your system.
27+
28+
#### Install via Homebrew (macOS/Linux)
29+
30+
The Arduino CLI is available as a Homebrew formula since version `0.5.0`:
31+
32+
```console
2733
brew update
2834
brew install arduino-cli
2935
```
30-
### Get the latest package
3136

32-
#### Using the install script
37+
#### Use the install script
3338

34-
The easiest way to get the latest version of `arduino-cli` on any supported platform is using the
35-
`install.sh` script:
39+
The easiest way to get the latest version of `arduino-cli` on any supported
40+
platform is using the `install.sh` script:
3641

3742
```console
3843
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
@@ -45,9 +50,10 @@ for example `~/local/bin`, set the `BINDIR` environment variable like this:
4550
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=~/local/bin sh
4651
```
4752

48-
#### Using the latest release links
53+
#### Download the latest packages from Arduino CDN
4954

50-
In order to get the latest stable release for your platform use the following links:
55+
In order to get the latest stable release for your platform you can use the
56+
following links:
5157

5258
- [Linux 64 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_64bit.tar.gz)
5359
- [Linux 32 bit](https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Linux_32bit.tar.gz)
@@ -63,17 +69,17 @@ available stable release. Once downloaded, place the executable `arduino-cli` in
6369
**Deprecation notice:** Links in the form `http://downloads.arduino.cc/arduino-cli/arduino-cli-latest-<platform>.tar.bz2`
6470
won't be further updated. That URL will provide arduino-cli 0.3.7-alpha.preview, regardless of further releases.
6571

66-
#### Using the Github release page
67-
68-
Alternatively you can download one of the pre-built binaries for the supported platforms from the
69-
[release page](https://github.com/arduino/arduino-cli/releases). Once downloaded, place the executable
70-
`arduino-cli` into a directory which is in your `PATH`.
72+
#### Download the latest package from the release page on GitHub
7173

72-
### Download a nightly build
74+
Alternatively you can download one of the pre-built binaries for the supported
75+
platforms from the
76+
[release page](https://github.com/arduino/arduino-cli/releases). Once downloaded,
77+
place the executable `arduino-cli` into a directory which is in your `PATH`.
7378

74-
These builds are generated once a day from `master` branch starting at 01:00 GMT
79+
### Get a nightly build
7580

76-
In order to get the latest nightly build for your platform use the following links:
81+
These builds are generated once a day from `master` branch starting at 01:00 GMT.
82+
In order to get the latest nightly build for your platform, use the following links:
7783

7884
- [Linux 64 bit](https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_64bit.tar.gz)
7985
- [Linux 32 bit](https://downloads.arduino.cc/arduino-cli/nightly/arduino-cli_nightly-latest_Linux_32bit.tar.gz)
@@ -86,16 +92,16 @@ In order to get the latest nightly build for your platform use the following lin
8692
These links return a `302: Found` response, redirecting to latest generated builds by replacing `latest` with the latest
8793
available build date, using the format YYYYMMDD (i.e for 2019/Aug/06 `latest` is replaced with `20190806` )
8894

89-
Checksums for the nightly builds are available at
95+
Checksums for the nightly builds are available at
9096
`https://downloads.arduino.cc/arduino-cli/nightly/nightly-<DATE>-checksums.txt`
9197

9298
Once downloaded, place the executable `arduino-cli` into a directory which is in your `PATH`.
9399

94-
### Build from source with Docker
100+
### Build from source using Docker
95101

96-
If you don't have a working Golang environment or if you want to build `arduino-cli` targeting
97-
different platforms, you can use Docker to get a binary directly from sources. From the project
98-
folder run:
102+
If you don't have a working Golang environment or if you want to build
103+
`arduino-cli` targeting different platforms, you can use Docker to get a binary
104+
directly from sources. From the project folder run:
99105

100106
```console
101107
docker run -v $PWD:/arduino-cli -w /arduino-cli -e PACKAGE_NAME_PREFIX='snapshot' arduino/arduino-cli:builder-1 goreleaser --rm-dist --snapshot --skip-publish
@@ -134,7 +140,7 @@ void loop() {
134140

135141
### Step 2. Modify your sketch
136142

137-
Use your favourite file editor or IDE to modify the .ino file, in this example
143+
Use your favourite file editor or IDE to modify the .ino file, in this example
138144
under: `$HOME/MyFirstSketch/MyFirstSketch.ino`
139145
and change the file to look like this one:
140146

0 commit comments

Comments
 (0)