Skip to content

Commit c8a3f2e

Browse files
authored
[skip changelog] Mention interfaces in documentation introduction (#1545)
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.
1 parent 1243277 commit c8a3f2e

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
![cli-logo](./docs/img/CLI_Logo_small.png)
44

55
Arduino CLI is an all-in-one solution that provides Boards/Library Managers, sketch builder, board detection, uploader,
6-
and many other tools needed to use any Arduino compatible board and platform.
6+
and many other tools needed to use any Arduino compatible board and platform from command line or machine interfaces.
77

88
[![Test Go status](https://github.com/arduino/arduino-cli/actions/workflows/test-go-task.yml/badge.svg)](https://github.com/arduino/arduino-cli/actions/workflows/test-go-task.yml)
99
[![Test Integration status](https://github.com/arduino/arduino-cli/actions/workflows/test-go-integration-task.yml/badge.svg)](https://github.com/arduino/arduino-cli/actions/workflows/test-go-integration-task.yml)

docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Arduino CLI is an all-in-one solution that provides Boards/Library Managers, sketch builder, board detection, uploader,
2-
and many other tools needed to use any Arduino compatible board and platform.
2+
and many other tools needed to use any Arduino compatible board and platform from command line or machine interfaces.
33

44
In addition to being a standalone tool, Arduino CLI is the heart of all official Arduino development software (Arduino
55
IDE, Arduino Web Editor). Parts of this documentation apply to those tools as well.

0 commit comments

Comments
 (0)