Skip to content

GitLab

A
arduino-cli
Switch branch/tag
  1. 26 Nov, 2021 3 commits
  3. 23 Nov, 2021 2 commits
  5. 22 Nov, 2021 2 commits
  7. 19 Nov, 2021 29 commits
  9. 17 Nov, 2021 1 commit
  11. 11 Nov, 2021 3 commits
    • Cristian Maglie's avatar
      [skip-changelog] Added process.RunWithinContext method (#1546) · bf4a7844
      Cristian Maglie authored 
      This method allows to bound process execution to a context.
      bf4a7844
    • per1234's avatar
      [skip changelog] Mention interfaces in documentation introduction (#1545) · c8a3f2ef
      per1234 authored 
      Unlike the IDE and Web Editor, Arduino CLI is intended to be used directly only by advanced users. However, all types of
users are likely to visit the repository and documentation website. Some of these readers will not be familiar with the
meaning of the acronym "CLI".

The previous documentation introduces Arduino CLI as:

> an all-in-one solution that provides [wonderful things] to use any Arduino compatible board and platform

Which sounds like something every Arduino user would be interested in.

Those readers might therefore get the impression this is some sort of GUI application like the IDE and be frustrated and confused
after spending time to install and run the program, only to find that it doesn't apparently do anything when they run the
executable (because they did it from a file browser or shortcut).

It is a bit difficult to describe Arduino CLI's interface in a short introduction because, despite the "CLI" in the name,
command line is only one of the interfaces offered by Arduino CLI (the others being the gRPC and Go APIs). I added the
term "machine" to cover the others.
      c8a3f2ef
    • per1234's avatar
      [skip changelog] Sync install docs from "template" (#1544) · 1243277b
      per1234 authored 
      * 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.

* 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.

* 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.

* Align heading levels in install docs

This document is intended to provide a list of installation options:

- brew
- script
- download
- build

but the heading levels were misaligned, which resulted in this structure:

-brew
- script
  - download
  - build
      1243277b