From e4c7d6409bbf334df2e0f1c7b0ec00d33a789a27 Mon Sep 17 00:00:00 2001
From: Hugo Pointcheval <git@pcl.ovh>
Date: Fri, 27 Jan 2023 11:22:59 +0100
Subject: [PATCH] docs: add brickgen in root readme
---
.gitignore | 1 +
README.md | 14 +++++++++++++-
mason-lock.json | 1 -
mason.yaml | 6 ++++--
4 files changed, 18 insertions(+), 4 deletions(-)
delete mode 100644 mason-lock.json
diff --git a/.gitignore b/.gitignore
index b8cf6b3..3e94738 100644
--- a/.gitignore
+++ b/.gitignore
@@ -197,3 +197,4 @@ $RECYCLE.BIN/
.idea/
*.iml
.mason/
+mason-lock.json
\ No newline at end of file
diff --git a/README.md b/README.md
index 8605d14..b307755 100644
--- a/README.md
+++ b/README.md
@@ -53,10 +53,22 @@ mason init
## Create a Brick
+- Create a **Brickgen** project in `apps/`.
+
```sh
-mason new <BRICK> -o ./bricks
+mason make wyatt_brick_template -o apps/new_brick
```
+- Create/Modify your compilable code in `apps/new_brick/new_brick`.
+- Customize the `brickgen.yaml` config file.
+- Generate the brick using `brickgen` cli tool.
+
+```sh
+dart ./tools/brick_generator/bin/brickgen.dart ./apps/new_brick/ ./bricks/
+```
+
+> More infos about generator in `./tools/brick_generator`.
+
## Use
Please add your bricks in `./bricks`. (See `Create a Brick` section)
diff --git a/mason-lock.json b/mason-lock.json
deleted file mode 100644
index a1b2b29..0000000
--- a/mason-lock.json
+++ /dev/null
@@ -1 +0,0 @@
-{"bricks":{"core_app_brick":{"path":"bricks/core_app_brick"},"wyatt_package":{"path":"bricks/wyatt_package"},"wyatt_clean_code":{"path":"bricks/wyatt_clean_code"},"wyatt_feature_brick":{"path":"../../../bricks/wyatt_feature_brick/"}}}
\ No newline at end of file
diff --git a/mason.yaml b/mason.yaml
index 8cfe754..7c67dd0 100644
--- a/mason.yaml
+++ b/mason.yaml
@@ -1,5 +1,3 @@
-# Register bricks which can be consumed via the Mason CLI.
-# https://github.com/felangel/mason
bricks:
core_app_brick:
path: bricks/core_app_brick
@@ -9,3 +7,7 @@ bricks:
path: bricks/wyatt_clean_code
wyatt_feature_brick:
path: bricks/wyatt_feature_brick
+ wyatt_brick_template:
+ path: bricks/wyatt_brick_template
+ wyatt_app_template:
+ path: bricks/wyatt_app_template
\ No newline at end of file