Skip to content

Commit 6b0e2a5

Browse files
committed
docs: update development guide for clarity and completeness
1 parent 982afd4 commit 6b0e2a5

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/contributor-guide/development.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Development Guide
44

55
> [!NOTE]
6-
> The `arduino-app-cli` is designed to run on the Board and access peripherals that are not available on a development PC (e.g., the microcontroller).
6+
> The `arduino-app-cli` is designed to run on the Board and access peripherals that are not available on a development PC.
77
>
88
> For easier testing, using an **Arduino UNO Q** is recommended, as local testing is limited to functionalities that do not require board-specific features.
99
@@ -13,8 +13,10 @@ The following development tools must be available in your local environment:
1313

1414
- [Go](https://go.dev/dl/)
1515
- [Task](https://taskfile.dev/)
16+
- [Docker](https://docs.docker.com/engine/install/)
1617
- [adb client](https://developer.android.com/tools/adb) [optionally]
1718

19+
1820
## Building the Project
1921

2022
- `task init`
@@ -24,12 +26,19 @@ The following development tools must be available in your local environment:
2426

2527
## Running Checks
2628

29+
> [!NOTE]
30+
> Since the `arduino-app-cli` runs on a debian-based OS, some tests do not work on Windows and macOS
31+
2732
Checks and tests are set up to ensure the project content is functional and compliant with the established standards.
2833

2934
- `task fmt-check`
3035
- `task lint`
3136
- `task test`
3237

38+
In particular, `task test` runs the following tests
39+
- `test:pkg` which exposes cross-platform api for working with the board (those should run for every platform)
40+
- `test:internal` runs test of the internal component of the app-cli, which targets only Linux
41+
3342
## Installing arduino-app-cli into the board
3443

3544
This is reccomended way to test a local development version of the arduino-app-cli into a board.

0 commit comments

Comments
 (0)