Skip to content

Commit

Permalink
Update cargo-generate instructions (#303)
Browse files Browse the repository at this point in the history
Fixes #302.

Ideally the template would run `cargo update -p {{package-name}}` for
the user in a post-generate script, but it's not clear if there's an
easy way to do so from a Rhai script.
  • Loading branch information
benfrankel authored Sep 12, 2024
1 parent fabd64f commit 21f295a
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,18 @@ See our [Design Document](./docs/design.md) for more information on how we struc

## Create a new game

Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) and run the following commands:
Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) and run the following command:

```sh
cargo generate TheBevyFlock/bevy_quickstart --branch cargo-generate
```

Then navigate to the newly generated directory and run the following commands:

```sh
git branch --move main
cargo update
git commit -am 'Initial commit'
```

Then [create a GitHub repository](https://github.com/new) and push your local repository to it.
Expand Down

0 comments on commit 21f295a

Please sign in to comment.