Skip to content

Commit ba4b028

Browse files
committed
docs: improve clarity in development guide by restructuring build instructions
1 parent 6b0e2a5 commit ba4b028

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

docs/contributor-guide/development.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,15 @@ The following development tools must be available in your local environment:
1919

2020
## Building the Project
2121

22+
Build the project (run once):
2223
- `task init`
2324
- `task build`
2425
- `task generate:assets` to download locally the assets of the [Arduino Bricks](`https://github.com/arduino/app-bricks-py`)
25-
- `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.
26+
27+
Start the arduino-app-cli in daemon mode:
28+
- `ARDUINO_APP_CLI__DATA_DIR=debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli task start`
29+
30+
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.
2631

2732
## Running Checks
2833

@@ -39,7 +44,7 @@ In particular, `task test` runs the following tests
3944
- `test:pkg` which exposes cross-platform api for working with the board (those should run for every platform)
4045
- `test:internal` runs test of the internal component of the app-cli, which targets only Linux
4146

42-
## Installing arduino-app-cli into the board
47+
## Running `arduino-app-cli` into the board
4348

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

0 commit comments

Comments
 (0)