Skip to content

Commit 25b9301

Browse files
authored
Readme nomenclature (#1)
1 parent 56aa90f commit 25b9301

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Arduino Apps Brick Library
22

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).
44

55
## What is a Brick?
66

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.
88

99
## Directory Structure
1010

11-
Every brick must follow this standardized directory structure:
11+
Every Brick must follow this standardized directory structure:
1212

1313
```
1414
src/arduino/app_bricks/brick_name/
@@ -58,7 +58,7 @@ task init
5858

5959
This task will check the python version and install the required dependencies.
6060

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.
6262

6363
## Linting and formatting
6464

@@ -155,16 +155,16 @@ Build will start:
155155

156156
Release is split in 2 main actions.
157157
* 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
159159

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.
161161
After releasing a new version of AI containers, compose files that use AI containers must be updated.
162162

163163
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.
164164

165165
### Container layers
166166

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.
168168
Base images are built by "BASE - build base images" flow. This flow should be triggered only in case of base images update needs.
169169

170170
Base images are required to:

0 commit comments

Comments
 (0)