Skip to content

Commit a85d3f9

Browse files
committed
docs: update development guide with additional instructions and resources
1 parent a1bfdd8 commit a85d3f9

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

docs/CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ There are several ways you can get involved:
2222

2323
## Resources
2424

25-
- [**Development Guide**](development.md#development-guide)
25+
- [**Development Guide**](development.md#development-guide)

docs/contributor-guide/development.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,27 @@ The following development tools must be available in your local environment:
88

99
- [Go](https://go.dev/dl/)
1010
- [Taskfile](https://taskfile.dev/)
11+
- [ddb client]//https://developer.android.com/tools/adb) [optionally]
1112

1213
## Building the Project
1314

14-
<!-- TODO: add instructions for building -->
15+
- `task init`
16+
17+
## Uploading the arduino-app-cli into the board
18+
Connect an [Arduino UNO Q](https://www.arduino.cc/product-uno-q) board to the PC via USB.
19+
20+
- `task board:install` it installs the current `arduino-app-cli` inside the board (`adb` is needed). The password of the `ardiuno` username of the board is requested.
1521

1622
## Running Checks
1723

1824
Checks and tests are set up to ensure the project content is functional and compliant with the established standards.
1925

20-
<!-- TODO: add instructions for running checks -->
26+
- `task fmt-check`
27+
- `task test`
2128

2229
## Automatic Corrections
2330

2431
Tools are provided to automatically bring the project into compliance with some of the required checks.
2532

26-
<!-- TODO: add instructions for running fix operations -->
33+
- `task lint`
34+
- `task fmt`

0 commit comments

Comments
 (0)