Skip to content

Commit

Permalink
docs: update docs (#798)
Browse files Browse the repository at this point in the history
  • Loading branch information
renancaraujo authored Sep 18, 2023
1 parent 782e5ed commit b9db86b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 11 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,6 @@ very_good create docs_site my_docs_site

```

#### Syntax changes in v0.10.0

⚠️ v0.10.0 changed the syntax of the `very_good create` command. Learn about the changes [here][new_syntax_link].

---

### `very_good packages get`
Expand Down Expand Up @@ -158,14 +154,16 @@ See the complete list of commands and usage information.
Usage: very_good <command> [arguments]

Global options:
-h, --help Print this usage information.
--version Print the current version.
-h, --help Print this usage information.
--version Print the current version.
--[no-]verbose Noisy logging, including all shell commands executed.

Available commands:
create very_good create <output directory>
create very_good create <subcommand> <project-name> [arguments]
Creates a new very good project in the specified directory.
packages Command for managing packages.
test Run tests in a Dart or Flutter project.
update Update Very Good CLI.

Run "very_good help <command>" for more information about a command.
```
Expand Down
10 changes: 6 additions & 4 deletions site/docs/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Very Good CLI is a Command-Line Interface that enables you to generate VGV-opini
In order to use Very Good CLI you must have [Dart][dart_sdk] and [Flutter][flutter_sdk] installed on your machine.

:::info
Very Good CLI requires Dart `">=2.13.0 <3.0.0"`
Very Good CLI requires Dart `">=3.1.0 <4.0.0"`
:::

## Installing
Expand Down Expand Up @@ -104,14 +104,16 @@ See the complete list of commands and usage information.
Usage: very_good <command> [arguments]

Global options:
-h, --help Print this usage information.
--version Print the current version.
-h, --help Print this usage information.
--version Print the current version.
--[no-]verbose Noisy logging, including all shell commands executed.

Available commands:
create very_good create <output directory>
create very_good create <subcommand> <project-name> [arguments]
Creates a new very good project in the specified directory.
packages Command for managing packages.
test Run tests in a Dart or Flutter project.
update Update Very Good CLI.

Run "very_good help <command>" for more information about a command.
```
Expand Down
5 changes: 5 additions & 0 deletions site/docs/resources/tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Get step-by-step guides to using Very Good CLI.

- **[Flame Game Template][flame_game_tutorial]**: Learn how to generate a Flutter game, powered by the Flame Game Engine.

## Flutter Wear OS App

- **[Flutter Wear OS template][flutter_wear_os_tutorial]**: Based on the Core, learn how to generate a Flutter app made for Wear OS.

## Dart CLI Template

- **[Dart CLI Template][dart_cli_tutorial]**: Unlock the potential of Dart in the command line with the Dart CLI template.
Expand All @@ -33,3 +37,4 @@ Get step-by-step guides to using Very Good CLI.
[supabase_tutorial]: https://verygood.ventures/blog/flutter-app-very-good-cli-supabase
[test_tutorial]: https://verygood.ventures/blog/flutter-tests-very-good-cli
[flame_game_tutorial]: https://verygood.ventures/blog/generate-a-game-with-our-new-template
[flutter_wear_os_tutorial]: https://verygood.ventures/blog/building-wear-os-apps-with-flutter-a-very-good-guide

0 comments on commit b9db86b

Please sign in to comment.