8000 Updated docs · arduino/arduino-cli@97a9b5f · GitHub
[go: up one dir, main page]
Skip to content

Commit 97a9b5f

Browse files
cmagliecmaglie
committed
Updated docs
1 parent 9bf0d9c commit 97a9b5f

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

‎docs/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -327,8 +327,8 @@ changes in the generated code.
327327
### Additional settings
328328

329329
If you need to push a commit that's only shipping documentation changes or example files, thus a complete no-op for the
330-
test suite, please start the commit message with the string **[skip ci]** to skip the build and give that slot to
331-
someone else who does need it.
330+
test suite, please start the commit message with the string **[skip ci]** to skip the build and give that slot to someone
331+
else who does need it.
332332

333333
If your PR doesn't need to be included in the changelog, please start the commit message and PR title with the string
334334
**[skip changelog]**

‎docs/integration-options.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ The Arduino CLI is an open source Command Line Application written in [Golang] t
44
compile, verify and upload sketches to Arduino boards and that’s capable of managing all the software and tools needed
55
in the process. But don’t get fooled by its name: Arduino CLI can do much more than the average console application, as
66
shown by [Arduino IDE 2.x][arduino ide 2.x] and [Arduino Cloud], which rely on it for similar purposes but each one in a
7-
completely different way from the other. In this article we introduce the three pillars of the Arduino CLI, explaining
8-
how we designed the software so that it can be effectively leveraged under different scenarios.
7+
completely different way from the other. In this article we introduce the three pillars of the Arduino CLI, explaining how
8+
we designed the software so that it can be effectively leveraged under different scenarios.
99

1010
## The first pillar: command line interface
1111

@@ -132,18 +132,17 @@ $ arduino-cli lib search FlashStorage --format json | jq .libraries[0].latest
132132
```
133133

134134
Even if not related to software design, one last feature that’s worth mentioning is the availability of a one-line
135-
[installation script] that can be used to make the latest version of the Arduino CLI available on most systems with an
136-
HTTP client like curl or wget and a shell like bash.
135+
[installation script] that can be used to make the latest version of the Arduino CLI available on most systems with an HTTP
136+
client like curl or wget and a shell like bash.
137137

138138
For more information on Arduino CLI's command line interface, see the [command reference].
139139

140140
## The second pillar: gRPC interface
141141

142142
[gRPC] is a high performance [RPC] framework that can efficiently connect client and server applications. The Arduino
143-
CLI can act as a gRPC server (we call it [daemon mode]), exposing a set of procedures that implement the very same set
144-
of features of the command line interface and waiting for clients to connect and use them. To give an idea, the
145-
following is some [Golang] code capable of retrieving the version number of a remote running Arduino CLI server
146-
instance:
143+
CLI can act as a gRPC server (we call it [daemon mode]), exposing a set of procedures that implement the very same set of
144+
features of the command line interface and waiting for clients to connect and use them. To give an idea, the following is
145+
some [Golang] code capable of retrieving the version number of a remote running Arduino CLI server instance:
147146

148147
```go
149148
// This file is part of arduino-cli.
@@ -211,8 +210,8 @@ a common Golang API, based on the gRPC protobuf definitions: a set of functions
211210
offered by the Arduino CLI, so that when we provide a fix or a new feature, they are automatically available to both the
212211
command line and gRPC interfaces. The source modules implementing this API are implemented through the `commands`
213212
package, and it can be imported in other Golang programs to embed a full-fledged Arduino CLI. For example, this is how
214-
some backend services powering [Arduino Cloud] can compile sketches and manage libraries. Just to give you a taste of
215-
what it means to embed the Arduino CLI, here is how to search for a core using the API:
213+
some backend services powering [Arduino Cloud] can compile sketches and manage libraries. Just to give you a taste of what
214+
it means to embed the Arduino CLI, here is how to search for a core using the API:
216215

217216
```go
218217
// This file is part of arduino-cli.
@@ -297,7 +296,8 @@ use and provide support for.
297296
You can start playing with the Arduino CLI right away. The code is open source and [the repo][arduino cli repository]
298297
contains [example code showing how to implement a gRPC client][grpc client example]. If you’re curious about how we
299298
designed the low level API, have a look at the [commands package] and don’t hesitate to leave feedback on the [issue
300-
tracker] if you’ve got a use case that doesn’t fit one of the three pillars.
299+
tracker]
300+
if you’ve got a use case that doesn’t fit one of the three pillars.
301301

302302
[golang]: https://go.dev/
303303
[arduino ide 2.x]: https://github.com/arduino/arduino-ide

0 commit comments

Comments
 (0)
0