Skip to content

[skip changelog] Clarify installation instructions for Windows #706

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.

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 2 commits into from
May 21, 2020
Merged

[skip changelog] Clarify installation instructions for Windows #706

merged 2 commits into from
May 21, 2020

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented May 14, 2020

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Improve the installation instructions for Windows users.

  • What is the current behavior?

The installation instructions are not very friendly to Windows users.

  • What is the new behavior?

The installation process for Windows is documented a little bit better.

  • Does this PR introduce a breaking change?

No.

  • Other information:

Resolves (partially?) #705

per1234 added 2 commits May 13, 2020 23:47
…dows

It's already quite clear that the Homebrew installation method is not available for Windows, so the first option for Windows users is the install script, which is also not well supported on Windows.
…tallation docs

Although the installation script does recommend adding Arduino CLI to PATH, I though it worth providing an explanation of why in installation instructions.

I combined the various download sources into sub-headings of a single "Download" installation option section so that the PATH instructions could be provided prominently only once for that installation option.
@per1234 per1234 added topic: documentation Related to documentation for the project component/packaging labels May 14, 2020
@per1234 per1234 requested a review from ubidefeo May 14, 2020 07:16
Copy link
Member

@cmaglie cmaglie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, makes sense. 👍

@per1234 per1234 merged commit a7d7de0 into arduino:master May 21, 2020
@per1234 per1234 deleted the clarify-installation-instructions branch May 21, 2020 16:41
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants