Skip to content

Commit 56c16db

Browse files
committed
docs: improve clarity and correctness in development guide
1 parent 24911c3 commit 56c16db

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/contributor-guide/development.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ Start the arduino-app-cli in daemon mode:
3030

3131
- `ARDUINO_APP_CLI__DATA_DIR=debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli go tool task start`
3232

33-
NOTE: only a subset of HTTP APIs are working by running the daemon mode into a development PC. To run the `arduino-app-cli` into the board see `Running`arduino-app-cli`into the board` section.
33+
NOTE: only a subset of HTTP APIs are working by running the daemon mode on a development PC. To run Arduino App CLI on the board see the **Running Arduino App CLI on the board** section below.
3434

3535
## Running Checks
3636

3737
> [!NOTE]
38-
> Since the `arduino-app-cli` runs on a debian-based OS, some tests do not work on Windows and macOS
38+
> Since Arduino App CLI runs on a Debian-based OS, some tests do not work on Windows and macOS
3939
4040
Checks and tests are set up to ensure the project content is functional and compliant with the established standards.
4141

@@ -45,12 +45,12 @@ Checks and tests are set up to ensure the project content is functional and comp
4545

4646
In particular, `go tool task test` runs the following tests
4747

48-
- `test:pkg` which exposes cross-platform api for working with the board (those should run for every platform)
49-
- `test:internal` runs test of the internal component of the app-cli, which targets only Linux
48+
- `test:pkg` which exposes a cross-platform API for working with the board (those should run for every platform)
49+
- `test:internal` runs tests of the internal components, which targets only Linux
5050

51-
## Running `arduino-app-cli` into the board
51+
## Running Arduino App CLI on the board
5252

53-
This is reccomended way to test a local development version of the arduino-app-cli into a board.
53+
This is reccomended way to test a local development version of Arduino App CLI on a board.
5454

5555
1. Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB.
5656
1. `go tool task board:install` installs the current version of Arduino App CLI on the board (`adb` is needed). The password of the `arduino` username of the board is requested.

0 commit comments

Comments
 (0)