Skip to content

Commit 9e98c0e

Browse files
committed
Add installation instructions
1 parent a85d1d6 commit 9e98c0e

File tree

3 files changed

+66
-0
lines changed

3 files changed

+66
-0
lines changed

Diff for: docs/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Its focus is on the structure, metadata, and configuration of Arduino projects,
55
[specification](https://arduino.github.io/arduino-cli/latest/library-specification) compliance, Library Manager
66
submission [requirements](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ), and best practices.
77

8+
## Installation
9+
10+
See the [installation instructions](installation.md).
11+
812
## Getting started
913

1014
Once installed, you only need to open a terminal at your project folder and run the command:

Diff for: docs/installation.md

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
## Use the install script
2+
3+
The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows. The
4+
script can be run on Windows by installing [Git for Windows](https://gitforwindows.org/), then running it from Git Bash.
5+
6+
This script will install the latest version of arduino-lint to `$PWD/bin`:
7+
8+
```
9+
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/install.sh | sh
10+
```
11+
12+
If you want to target a different directory, for example `~/local/bin`, set the `BINDIR` environment variable like this:
13+
14+
```
15+
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/install.sh | BINDIR=~/local/bin sh
16+
```
17+
18+
If you would like to use the `arduino-lint` command from any location, install arduino-lint to a directory already in
19+
your `PATH` or add the arduino-lint installation path to your `PATH` environment variable.
20+
21+
If you want to download a specific arduino-lint version, for example `0.9.0`, pass the version number as a parameter
22+
like this:
23+
24+
```
25+
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/install.sh | sh -s 0.9.0
26+
```
27+
28+
### Download
29+
30+
Pre-built binaries for all the supported platforms are available for download from the links below.
31+
32+
If you would like to use the `arduino-lint` command from any location, extract the downloaded file to a directory
33+
already in your `PATH` or add the arduino-lint installation path to your `PATH` environment variable.
34+
35+
#### Latest release
36+
37+
| Platform | | |
38+
| --------- | -------------------- | -------------------- |
39+
| Linux | [32 bit][linux32] | [64 bit][linux64] |
40+
| Linux ARM | [32 bit][linuxarm32] | [64 bit][linuxarm64] |
41+
| Windows | [32 bit][windows32] | [64 bit][windows64] |
42+
| macOS | | [64 bit][macos] |
43+
44+
[linux64]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_Linux_64bit.tar.gz
45+
[linux32]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_Linux_32bit.tar.gz
46+
[linuxarm64]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_Linux_ARM64.tar.gz
47+
[linuxarm32]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_Linux_ARMv7.tar.gz
48+
[windows64]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_Windows_64bit.zip
49+
[windows32]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_Windows_32bit.zip
50+
[macos]: https://downloads.arduino.cc/arduino-lint/arduino-lint_latest_macOS_64bit.tar.gz
51+
52+
#### Previous versions
53+
54+
These are available from the "Assets" sections on the [releases page](https://github.com/arduino/arduino-lint/releases).
55+
56+
`https://downloads.arduino.cc/arduino-lint/nightly/nightly-<DATE>-checksums.txt`
57+
58+
### Build from source
59+
60+
If you’re familiar with Golang or if you want to contribute to the project, you will probably build arduino-lint locally
61+
with your Go toolchain. See the ["How to contribute"](CONTRIBUTING.md#building-the-source-code) page for instructions.

Diff for: mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ markdown_extensions:
4646
# Navigation
4747
nav:
4848
- Documentation Home: index.md
49+
- installation.md
4950
- Command reference: commands/arduino-lint.md
5051
- CONTRIBUTING.md
5152

0 commit comments

Comments
 (0)