docs: add brickgen in root readme
This commit is contained in:
parent
68c3e23ee4
commit
e4c7d6409b
1
.gitignore
vendored
1
.gitignore
vendored
@ -197,3 +197,4 @@ $RECYCLE.BIN/
|
||||
.idea/
|
||||
*.iml
|
||||
.mason/
|
||||
mason-lock.json
|
14
README.md
14
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)
|
||||
|
@ -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/"}}}
|
@ -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
|
Loading…
x
Reference in New Issue
Block a user