Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Use flutter pub add to add flame dependency #2823

Merged
merged 5 commits into from
Oct 19, 2023
Merged

docs: Use flutter pub add to add flame dependency #2823

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4bc909b
Use `flutter pub add` to add `flame` dependency
domesticmouse Oct 17, 2023
d8729ca
Add command output
domesticmouse Oct 17, 2023
c09e3ec
Merge branch 'main' into patch-1
domesticmouse Oct 18, 2023
81cf989
Drop command output
domesticmouse Oct 18, 2023
a46cc26
Drop `consts`
domesticmouse Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions doc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,21 @@ Give us a star if you want to help give the engine exposure and grow the communi

## Installation

Put the pub package as your dependency by putting the following in your `pubspec.yaml`:

```yaml
dependencies:
flame: --VERSION--
Add the `flame` package as a dependency in your `pubspec.yaml` by running the following command:

```console
$ flutter pub add flame
Resolving dependencies...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can skip the output of the command, it might confuse some beginners since it'll say different versions for them later

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The linter spat the dummy because I had the $ before the command and no output. I can strip it back to just the command without upsetting the linter?

collection 1.17.2 (1.18.0 available)
+ flame 1.10.0
material_color_utilities 0.5.0 (0.8.0 available)
meta 1.9.1 (1.11.0 available)
+ ordered_set 5.0.2
stack_trace 1.11.0 (1.11.1 available)
stream_channel 2.1.1 (2.1.2 available)
test_api 0.6.0 (0.6.1 available)
web 0.1.4-beta (0.3.0 available)
Changed 2 dependencies!
```

The latest version can be found on [pub.dev](https://pub.dev/packages/flame/install).
Expand Down