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
Next Next commit
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.
  • Loading branch information
@per1234
per1234 committed Nov 11, 2021
commit 8bc7aab10fda2793151677f35f5497425efdd6b8
2 changes: 2 additions & 0 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- Source: https://github.com/arduino/tooling-project-assets/blob/main/other/installation-script/installation.md -->

Several options are available for installation of Arduino Lint. Instructions for each are provided below:

## Use the install script

The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows. The
Expand Down