Skip to content

Commit

Permalink
Update README and delete cargo-generate.yaml (#308)
Browse files Browse the repository at this point in the history
This is a followup to
#305.

After this, `ci-generate.yaml` is the only remaining task. That needs a
little more time to cook in
https://github.com/TheBevyFlock/bevy_new_minimal first.
  • Loading branch information
benfrankel committed Sep 19, 2024
1 parent 2985688 commit 34e9570
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 148 deletions.
124 changes: 0 additions & 124 deletions .github/workflows/cargo-generate.yaml

This file was deleted.

25 changes: 1 addition & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,34 +22,11 @@ See our [Design Document](./docs/design.md) for more information on how we struc
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'
cargo generate TheBevyFlock/bevy_quickstart
```

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

<details>
<summary>This template can also be set up manually.</summary>

Navigate to the top of [this GitHub repository](https://github.com/TheBevyFlock/bevy_quickstart/) and select `Use this template > Create a new repository`:

![UI demonstration](./docs/img/readme-manual-setup.png)

Clone your new Github repository to a local repository and push a commit with the following changes:

- Delete `LICENSE`, `README`, and `docs/` files.
- Search for and replace instances of `bevy_quickstart` with the name of your project.
- Adjust the `env` variables in [`.github/workflows/release.yaml`](./.github/workflows/release.yaml).

</details>

## Write your game

The best way to get started is to play around with what you find in [`src/demo/`](./src/demo).
Expand Down

0 comments on commit 34e9570

Please sign in to comment.