You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Clarify that sh is not required in template install docs
A significant portion of Arduino users use Windows. The first option listed in the installation instructions is for an
installation shell script, which can be used on Windows, but might not be convenient for some Windows users.
This could be discouraging or frustrating to potential new users, but not necessarily so because the script is an
optional convenience and directly downloading and installing the tool is also an option, as documented in the
instructions for the second listed option.
A little refinement of the wording of the script's `sh` requirement makes the situation clear to those users.
Copy file name to clipboardExpand all lines: docs/installation.md
+3-2
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,9 @@ Several options are available for installation of Arduino Lint. Instructions for
4
4
5
5
## Use the install script
6
6
7
-
The script requires `sh`, which is always available on Linux and macOS. `sh` is not available by default on Windows. The
8
-
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).
9
10
10
11
This script will install the latest version of Arduino Lint to `$PWD/bin`:
0 commit comments