|
1 | 1 | # Arduino Apps Brick Library |
2 | 2 |
|
3 | | -Library is composed by configurable and reusable 'bricks', based on optional infrastructure (executed via docker compose) and wrapping python code (to simplify code usage). |
| 3 | +Library is composed by configurable and reusable 'Bricks', based on optional infrastructure (executed via Docker Compose) and wrapping Python® code (to simplify code usage). |
4 | 4 |
|
5 | 5 | ## What is a Brick? |
6 | 6 |
|
7 | | -A **brick** is a modular, reusable building block that provides specific functionality for Arduino applications. Each brick is self-contained with standardized configuration, consistent APIs, and optional Docker service definitions. |
| 7 | +A **Brick** is a modular, reusable building block that provides specific functionality for Arduino applications. Each Brick is self-contained with standardized configuration, consistent APIs, and optional Docker service definitions. |
8 | 8 |
|
9 | 9 | ## Directory Structure |
10 | 10 |
|
11 | | -Every brick must follow this standardized directory structure: |
| 11 | +Every Brick must follow this standardized directory structure: |
12 | 12 |
|
13 | 13 | ``` |
14 | 14 | src/arduino/app_bricks/brick_name/ |
@@ -58,7 +58,7 @@ task init |
58 | 58 |
|
59 | 59 | This task will check the python version and install the required dependencies. |
60 | 60 |
|
61 | | -To force a specific Apps Lab container version, use 'APPSLAB_VERSION' environment variable. |
| 61 | +To force a specific Arduino App Lab container version, use 'APPSLAB_VERSION' environment variable. |
62 | 62 |
|
63 | 63 | ## Linting and formatting |
64 | 64 |
|
@@ -155,16 +155,16 @@ Build will start: |
155 | 155 |
|
156 | 156 | Release is split in 2 main actions. |
157 | 157 | * Tag "ai/{version}" to release AI containers |
158 | | -* Tag "release/{version}" to release bricks library and containers |
| 158 | +* Tag "release/{version}" to release Bricks library and containers |
159 | 159 |
|
160 | | -This is done because release cycle for AI containers and bricks is different. So release is independent. |
| 160 | +This is done because release cycle for AI containers and Bricks is different. So release is independent. |
161 | 161 | After releasing a new version of AI containers, compose files that use AI containers must be updated. |
162 | 162 |
|
163 | 163 | To perform development, it is possible to use Dev build pipeline, suited to rebuild a full dev stack with containers updated to 'dev-latest' tag. |
164 | 164 |
|
165 | 165 | ### Container layers |
166 | 166 |
|
167 | | -Library containers are based on a set of pre-defined python base images that are updated with a different frequency wrt library release. |
| 167 | +Library containers are based on a set of pre-defined Python base images that are updated with a different frequency wrt library release. |
168 | 168 | Base images are built by "BASE - build base images" flow. This flow should be triggered only in case of base images update needs. |
169 | 169 |
|
170 | 170 | Base images are required to: |
|
0 commit comments