Skip to content

Commit af8659a

Browse files
committed
docs: Improve and update README.md
1 parent 5dfb341 commit af8659a

File tree

2 files changed

+456
-8
lines changed

2 files changed

+456
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[![Pub](https://img.shields.io/pub/v/ignite_cli.svg?style=popout)](https://pub.dartlang.org/packages/ignite_cli)
2-
[![Test](https://github.com/flame-engine/ignite-cli/workflows/Test/badge.svg?branch=main&event=push)](https://github.com/flame-engine/ignite-cli/actions)
2+
[![Test](https://github.com/flame-engine/ignite-cli/workflows/Test/badge.svg)](https://github.com/flame-engine/ignite-cli/actions)
33
[![Discord](https://img.shields.io/discord/509714518008528896.svg)](https://discord.gg/pxrBmy4)
44

55
# ignite-cli
@@ -12,7 +12,7 @@ Simple CLI interface for Ignite; scaffold and setup your Flame projects with eas
1212
Install it via pub (or build from src if you prefer the latest version):
1313

1414
```bash
15-
pub global activate ignite_cli
15+
flutter pub global activate ignite_cli
1616
```
1717

1818
After you have added the bin folder to your path (the previous command will tell you what to add),
@@ -22,7 +22,13 @@ you can create a new project with Ignite, just run:
2222
ignite create
2323
```
2424

25-
And follow the instructions.
25+
And follow the instructions (this is called interactive mode - you might need a compatible shell for the interactive pickers to work).
26+
27+
Alternatively, you can set `--interactive=false` and manually specify all required options (error messages will be your friend):
28+
29+
```bash
30+
ignite create --interactive=false --name=my_flame_game --org=org.flame-engine.example --create-folder=true --template=example
31+
```
2632

2733

2834
## Instructions for contributors
@@ -45,7 +51,7 @@ dart bin/ignite_cli.dart
4551
```
4652

4753

48-
## Managing Templates
54+
### Managing Templates
4955

5056
This project uses [package:mason](https://pub.dev/packages/mason) to manage and generate templates (bricks).
5157

@@ -54,12 +60,10 @@ All supported bricks can be found in the [bricks](./bricks) directory.
5460
Whenever a new brick is added or an existing brick is modified, make sure to regenerate the corresponding bundles via:
5561

5662
```bash
57-
mason bundle bricks/<BRICK-NAME> -t dart -o lib/templates
63+
./scripts/build.sh
5864
```
5965

60-
This will generate a new bundle for `<BRICK-NAME>` under `lib/templates`.
61-
6266

6367
## Credits
6468

65-
This project was created with [Dart Stagehand](https://github.com/dart-lang/stagehand).
69+
This project was created with [Dart Stagehand](https://github.com/dart-lang/stagehand) and uses [Mason](https://pub.dev/packages/mason) for templating.

0 commit comments

Comments
 (0)