From 21f295a64b1a617575c14aa5d0df1aee666935f8 Mon Sep 17 00:00:00 2001 From: Ben Frankel Date: Thu, 12 Sep 2024 04:55:32 +0300 Subject: [PATCH] Update `cargo-generate` instructions (#303) Fixes https://github.com/TheBevyFlock/bevy_quickstart/issues/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. --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6c5ef22..5a656d9 100644 --- a/README.md +++ b/README.md @@ -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.