Skip to content

Commit ee3aa5a

Browse files
committed
revmoe task0
g
1 parent 9a344a1 commit ee3aa5a

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

docs/contributor-guide/development.md

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

1414
- [Go](https://go.dev/dl/)
15-
- [Task](https://taskfile.dev/)
1615
- [Docker](https://docs.docker.com/engine/install/)
1716
- [adb client](https://developer.android.com/tools/adb) [optionally]
1817

1918
## Building the Project
2019

2120
Build the project (run once):
2221

23-
- `task init`
24-
- `task build`
2522
- `go tool task init`
2623
- `go tool task build`
27-
- `go tool task generate:assets` to download locally the assets of the [Arduino Bricks](https://github.com/arduino/app-bricks-py)
24+
- `go tool task generate:assets` to download locally the assets of the [Arduino Bricks](`https://github.com/arduino/app-bricks-py`)
2825

2926
Start the arduino-app-cli in daemon mode:
3027

@@ -39,11 +36,11 @@ NOTE: only a subset of HTTP APIs are working by running the daemon mode into a d
3936
4037
Checks and tests are set up to ensure the project content is functional and compliant with the established standards.
4138

42-
- `task fmt-check`
43-
- `task lint`
44-
- `task test`
39+
- `go tool task fmt-check`
40+
- `go tool task lint`
41+
- `go tool task test`
4542

46-
In particular, `task test` runs the following tests
43+
In particular, `go tool task test` runs the following tests
4744

4845
- `test:pkg` which exposes cross-platform api for working with the board (those should run for every platform)
4946
- `test:internal` runs test of the internal component of the app-cli, which targets only Linux
@@ -53,17 +50,17 @@ In particular, `task test` runs the following tests
5350
This is reccomended way to test a local development version of the arduino-app-cli into a board.
5451

5552
1. Connect an [Arduino UNO Q](https://docs.arduino.cc/hardware/uno-q/) board via USB.
56-
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.
53+
1. `go tool 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.
5754

5855
## Automatic Corrections
5956

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

62-
- `task fmt`
59+
- `go tool task fmt`
6360

6461
## Generate API docs
6562

6663
If a PR, change the HTTP API definitions, the following steps are needed:
6764

6865
1. Open the `cmd/gendoc/docs.go` and modify/add/remove the definitions
69-
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)
66+
1. Run `go tool task doc` to generate the docs (i.e., the files `internal/api/docs/openapi.yaml` and `internal/e2e/client/client.gen.go` are generated)

0 commit comments

Comments
 (0)