You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contributor-guide/development.md
+15-6Lines changed: 15 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,11 @@
2
2
3
3
#Development Guide
4
4
5
+
>[!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).
7
+
>
8
+
>For easier testing, using an**Arduino UNO Q** is recommended, as local testing is limited to functionalities that do not require board-specific features.
9
+
5
10
##Prerequisites
6
11
7
12
The following development tools must be available in your local environment:
@@ -13,6 +18,9 @@ The following development tools must be available in your local environment:
13
18
##Building the Project
14
19
15
20
-`task init`
21
+
-`task build`
22
+
-`task generate:assets` to download locally the assets of the[Arduino Bricks](`https://github.com/arduino/app-bricks-py`)
23
+
-`ARDUINO_APP_CLI__DATA_DIR=debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli task start` to build and start the arduino-app-cli in daemon mode.
16
24
17
25
##Running Checks
18
26
@@ -21,11 +29,10 @@ Checks and tests are set up to ensure the project content is functional and comp
21
29
-`task fmt-check`
22
30
-`task test`
23
31
24
-
##Testing arduino-app-cli into the board
25
-
Connect an[Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB.
26
-
27
-
-`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.
28
-
32
+
##Installing arduino-app-cli into the board
33
+
This is reccomended way to test a local development version of the arduino-app-cli into a board.
34
+
1. Connect an[Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB.
35
+
1.`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.
29
36
30
37
##Automatic Corrections
31
38
@@ -36,4 +43,6 @@ Tools are provided to automatically bring the project into compliance with some
36
43
37
44
38
45
##Generate API docs
39
-
If th
46
+
If a PR, change the HTTP API definitions, the following steps are needed:
47
+
1. Open the`cmd/gendoc/docs.go` and modify/add/remove the definitions
48
+
1. Run`task doc` to generate the docs (i.e., the files`internal/api/docs/openapi.yaml` and`internal/e2e/client/client.gen.go` are generated)
- Search[existing pull requests and issues](https://github.com/arduino/arduino-app-cli/issues?q=) to see if it was already reported.<br />
20
20
If you have additional information to provide about an existing issue, please comment there instead of creating a duplicate. You can use[GitHub's "Reactions" feature](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) if you only want to express support 👍.