From 2badd020ff74d65e5406edde15cca8e62a244b34 Mon Sep 17 00:00:00 2001 From: per1234 Date: Wed, 10 Nov 2021 18:34:40 -0800 Subject: [PATCH] [skip changelog] Mention interfaces in documentation introduction 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 [...] to use any Arduino compatible board and platform Which sounds like something any 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 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 provided by Arduino CLI (the others being the gRPC and Go API). I added the term "machine" to cover the others. --- README.md | 2 +- docs/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 348e59d9d6a..050ffe316b0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ ![cli-logo](./docs/img/CLI_Logo_small.png) Arduino CLI is an all-in-one solution that provides Boards/Library Managers, sketch builder, board detection, uploader, -and many other tools needed to use any Arduino compatible board and platform. +and many other tools needed to use any Arduino compatible board and platform from command line or machine interfaces. [![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) [![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) diff --git a/docs/index.md b/docs/index.md index cb7235cd0be..1e85317f7a6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,5 @@ Arduino CLI is an all-in-one solution that provides Boards/Library Managers, sketch builder, board detection, uploader, -and many other tools needed to use any Arduino compatible board and platform. +and many other tools needed to use any Arduino compatible board and platform from command line or machine interfaces. In addition to being a standalone tool, Arduino CLI is the heart of all official Arduino development software (Arduino IDE, Arduino Web Editor). Parts of this documentation apply to those tools as well.