Skip to content

Sync install docs from "template" #291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 11, 2021
Merged

Sync install docs from "template" #291

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2c3fe9
Align heading levels in install docs
per1234 Nov 11, 2021
8bc7aab
Add an introduction to install docs
per1234 Nov 11, 2021
ed05a16
Clarify that sh is not required in template install docs
per1234 Nov 11, 2021
12ac205
Add a reference link re: PATH to install docs
per1234 Nov 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
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.
  • Loading branch information
@per1234
per1234 committed Nov 11, 2021
commit 12ac20521b23406ada69a0853bd094b865e36772
6 changes: 4 additions & 2 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/insta
```

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

If you want to download a specific Arduino Lint version, for example `0.9.0` or `nightly-latest`, pass the version
number as a parameter like this:
Expand All @@ -35,7 +36,8 @@ curl -fsSL https://raw.githubusercontent.com/arduino/arduino-lint/main/etc/insta
Pre-built binaries for all the supported platforms are available for download from the links below.

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

### Latest release

Expand Down