Skip to content

Commit d987f6e

Browse files
authored
Merge pull request #291 from per1234/sync-install-docs
Sync install docs from "template"
2 parents 1ffea34 + 12ac205 commit d987f6e

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

Diff for: docs/installation.md

+14-9
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
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 Lint. Instructions for each are provided below:
4+
35
## Use the install script
46

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

811
This script will install the latest version of Arduino Lint to `$PWD/bin`:
912

@@ -18,7 +21,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/insta
1821
```
1922

2023
If you would like to use the `arduino-lint` command from any location, install Arduino Lint to a directory already in
21-
your `PATH` or add the Arduino Lint installation path to your `PATH` environment variable.
24+
your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino Lint installation path to your
25+
`PATH` environment variable.
2226

2327
If you want to download a specific Arduino Lint version, for example `0.9.0` or `nightly-latest`, pass the version
2428
number as a parameter like this:
@@ -27,14 +31,15 @@ number as a parameter like this:
2731
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/install.sh | sh -s 0.9.0
2832
```
2933

30-
### Download
34+
## Download
3135

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

3438
If you would like to use the `arduino-lint` command from any location, extract the downloaded file to a directory
35-
already in your `PATH` or add the Arduino Lint installation path to your `PATH` environment variable.
39+
already in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the Arduino Lint installation path
40+
to your `PATH` environment variable.
3641

37-
#### Latest release
42+
### Latest release
3843

3944
| Platform | | |
4045
| --------- | -------------------- | -------------------- |
@@ -51,11 +56,11 @@ already in your `PATH` or add the Arduino Lint installation path to your `PATH`
5156
[windows32]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_Windows_32bit.zip
5257
[macos]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_macOS_64bit.tar.gz
5358

54-
#### Previous versions
59+
### Previous versions
5560

5661
These are available from the "Assets" sections on the [releases page](https://github.com/arduino/arduino-lint/releases).
5762

58-
#### Nightly builds
63+
### Nightly builds
5964

6065
These builds are generated every day at 01:00 GMT from the `main` branch and should be considered unstable. In order to
6166
get the latest nightly build available for the supported platform, use the following links:
@@ -81,7 +86,7 @@ get the latest nightly build available for the supported platform, use the follo
8186
Checksums for the nightly builds are available at
8287
`https://downloads.arduino.cc/arduino-lint/nightly/nightly-<DATE>-checksums.txt`
8388

84-
### Build from source
89+
## Build from source
8590

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

0 commit comments

Comments
 (0)