Skip to content

Commit e6cffa3

Browse files
docs(site): create command updates (#1328)
1 parent 28c37a0 commit e6cffa3

File tree

10 files changed

+34
-1
lines changed

10 files changed

+34
-1
lines changed

.github/workflows/release_please.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ on:
99
push:
1010
branches:
1111
- main
12+
paths:
13+
- "!.github/workflows/site.yaml"
14+
- "!site/**"
1215

1316
jobs:
1417
create_release_pr:

site/docs/overview.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,9 @@ dart pub global run very_good_cli:very_good <command> <args>
4242

4343
### `very_good create`
4444

45-
Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command. Ex: `very_good create flutter_app` will generate a Flutter starter app.
45+
Create a very good project in seconds based on the provided template. Each template has a corresponding sub-command.
46+
47+
Ex: `very_good create flutter_app my_app` will generate a Flutter starter app named `my_app`.
4648

4749
```sh
4850
Creates a new very good project in the specified directory.
@@ -62,6 +64,10 @@ Available subcommands:
6264
Run "very_good help" to see global options.
6365
```
6466

67+
:::tip
68+
You can use `.` as the project name to create the project in the current directory. The project will be named with the name of the current directory.
69+
:::
70+
6571
### `very_good packages get`
6672

6773
Get packages in a Dart or Flutter project.

site/docs/templates/core.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ very_good create flutter_app my_app --desc "My new Flutter app"
5656

5757
# Create a new Flutter app named my_app with a custom org
5858
very_good create flutter_app my_app --desc "My new Flutter app" --org "com.custom.org"
59+
60+
# Create a new Flutter app named with the name of the current directory
61+
very_good create flutter_app . --desc "My new Flutter app"
5962
```
6063

6164
### Running the Project ⚡

site/docs/templates/dart_cli.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ very_good create dart_cli my_dart_cli --desc "My new Dart CLI package"
1616

1717
# Create a new Dart CLI application named my_dart_cli with a custom executable name
1818
very_good create dart_cli my_dart_cli --desc "My new Dart CLI package" --executable-name my_executable_name
19+
20+
# Create a new Dart CLI named with the name of the current directory
21+
very_good create dart_cli . --desc "My new Dart CLI package"
1922
```
2023

2124
[dart_cli]: /img/dart_cli_hero.png

site/docs/templates/dart_pkg.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,7 @@ very_good create dart_package my_dart_package --desc "My new Dart package"
1414

1515
# Create a new Dart package named my_dart_package that is publishable
1616
very_good create dart_package my_dart_package --desc "My new Dart package" --publishable
17+
18+
# Create a new Dart package named with the name of the current directory
19+
very_good create dart_package . --desc "My new Dart package"
1720
```

site/docs/templates/docs_site.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ This template is powered by [Docusaurus][docusaurus_link] and comes with the fol
3131
```sh
3232
# Create a new docs site named my_docs_site
3333
very_good create docs_site my_docs_site
34+
35+
# Create a new docs site named with the name of the current directory
36+
very_good create docs_site .
3437
```
3538

3639
## Preview 📝

site/docs/templates/federated_plugin.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin"
2828
very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" --platforms=android,ios,web
2929
# or
3030
very_good create flutter_plugin my_flutter_plugin --desc "My new Flutter plugin" --platforms android --platforms ios --platforms web
31+
32+
# Create a new Flutter plugin named with the name of the current directory
33+
very_good create flutter_plugin . --desc "My new Flutter plugin" --platforms android,ios,web
3134
```
3235

3336
[federated_plugin_docs]: https://docs.flutter.dev/development/packages-and-plugins/developing-packages#federated-plugins

site/docs/templates/flame_game.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ Read more about this game template [in our blog][blog].
2929
```sh
3030
# Create a new Flame game named my_game
3131
very_good create flame_game my_game --desc "My new Flame game"
32+
33+
# Create a new Flame game named with the name of the current directory
34+
very_good create flame_game . --desc "My new Flame game"
3235
```
3336

3437
[blog]: https://verygood.ventures/blog/generate-a-game-with-our-new-template

site/docs/templates/flutter_pkg.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,7 @@ very_good create flutter_package my_flutter_package --desc "My new Flutter packa
1414

1515
# Create a new Flutter package named my_flutter_package that is publishable
1616
very_good create flutter_package my_flutter_package --desc "My new Flutter package" --publishable
17+
18+
# Create a new Flutter package named with the name of the current directory
19+
very_good create flutter_package . --desc "My new Flutter package"
1720
```

site/docs/templates/wear.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ Read more about this app template [in our blog][blog].
2929
```sh
3030
# Create a new Wear OS app named my_wear_app
3131
very_good create flutter_app my_wear_app --desc "My new Wear OS app" --template wear
32+
33+
# Create a new Wear OS named with the name of the current directory
34+
very_good create flutter_app . --desc "My new Wear OS app" --template wear
3235
```
3336

3437
[blog]: https://verygood.ventures/blog/building-wear-os-apps-with-flutter-a-very-good-guide

0 commit comments

Comments
 (0)