Skip to content

Commit 9a344a1

Browse files
committed
docs: update development guide for clarity and accuracy in build instructions
1 parent 24b9228 commit 9a344a1

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/contributor-guide/development.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,26 @@ The following development tools must be available in your local environment:
1616
- [Docker](https://docs.docker.com/engine/install/)
1717
- [adb client](https://developer.android.com/tools/adb) [optionally]
1818

19-
2019
## Building the Project
2120

2221
Build the project (run once):
22+
2323
- `task init`
2424
- `task build`
2525
- `go tool task init`
2626
- `go tool task build`
2727
- `go tool task generate:assets` to download locally the assets of the [Arduino Bricks](https://github.com/arduino/app-bricks-py)
2828

2929
Start the arduino-app-cli in daemon mode:
30+
3031
- `ARDUINO_APP_CLI__DATA_DIR=debian/arduino-app-cli/home/arduino/.local/share/arduino-app-cli task start`
3132

32-
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 into a development PC. To run the `arduino-app-cli` into the board see `Running`arduino-app-cli`into the board` section.
3334

3435
## Running Checks
3536

3637
> [!NOTE]
37-
> Since the `arduino-app-cli` runs on a debian-based OS, some tests do not work on Windows and macOS
38+
> Since the `arduino-app-cli` runs on a debian-based OS, some tests do not work on Windows and macOS
3839
3940
Checks and tests are set up to ensure the project content is functional and compliant with the established standards.
4041

@@ -43,6 +44,7 @@ Checks and tests are set up to ensure the project content is functional and comp
4344
- `task test`
4445

4546
In particular, `task test` runs the following tests
47+
4648
- `test:pkg` which exposes cross-platform api for working with the board (those should run for every platform)
4749
- `test:internal` runs test of the internal component of the app-cli, which targets only Linux
4850

0 commit comments

Comments
 (0)