diff --git a/README.md b/README.md index 236409c2..96575b78 100644 --- a/README.md +++ b/README.md @@ -17,13 +17,13 @@ Then [create a GitHub repository](https://github.com/new) and push your local re Navigate to the top of [this GitHub repository](https://github.com/TheBevyFlock/bevy_quickstart/) and select `Use this template > Create a new repository`: -![example](TODO) +![UI demonstration](./docs/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). +- Adjust the `env` variables in [`.github/workflows/release.yaml`](./.github/workflows/release.yaml). @@ -31,18 +31,18 @@ Clone your new Github repository to a local repository and push a commit with th This template comes with a basic project structure that you may find useful: -| Path | Description | -|----------------------------------------|-------------------------------------------------------| -| [`src/lib.rs`](src/lib.rs) | App setup | -| [`src/screen/`](src/screen) | Splash screen, title screen, playing screen, etc. | -| [`src/game/`](src/game) | Game mechanics & content (replace with your own code) | -| [`src/ui/`](src/ui) | Reusable UI widgets & theming | -| [`src/dev_tools.rs`](src/dev_tools.rs) | Dev tools for dev builds | +| Path | Description | +|------------------------------------------|-------------------------------------------------------| +| [`src/lib.rs`](./src/lib.rs) | App setup | +| [`src/screen/`](./src/screen) | Splash screen, title screen, playing screen, etc. | +| [`src/game/`](./src/game) | Game mechanics & content (replace with your own code) | +| [`src/ui/`](./src/ui) | Reusable UI widgets & theming | +| [`src/dev_tools.rs`](./src/dev_tools.rs) | Dev tools for dev builds | Feel free to move things around however you want, though. > [!Tip] -> Be sure to check out the amazing [3rd-party tools](docs/tooling.md) in the Bevy ecosystem! +> Be sure to check out the amazing [3rd-party tools](./docs/tooling.md) in the Bevy ecosystem! ## Run your game @@ -51,22 +51,22 @@ Running your game locally is very simple: - Use `cargo run` to run a native dev build. - Use [`trunk serve`](https://trunkrs.dev/) to run a web dev build. -If you're using [VS Code](https://code.visualstudio.com/), this template comes with a [`.vscode/tasks.json`](.vscode/tasks.json) file. +If you're using [VS Code](https://code.visualstudio.com/), this template comes with a [`.vscode/tasks.json`](./.vscode/tasks.json) file. ## Release your game -This template uses [GitHub workflows](https://docs.github.com/en/actions/using-workflows) to run tests and build releases. See [Workflows](docs/workflows.md) for more information. +This template uses [GitHub workflows](https://docs.github.com/en/actions/using-workflows) to run tests and build releases. See [Workflows](./docs/workflows.md) for more information. ## License The source code in this repository is licensed under any of the following at your option: -- [CC0-1.0 License](LICENSE-CC0-1.0.txt) -- [MIT License](LICENSE-MIT.txt) -- [Apache License, Version 2.0](LICENSE-Apache-2.0.txt) +- [CC0-1.0 License](./LICENSE-CC0-1.0.txt) +- [MIT License](./LICENSE-MIT.txt) +- [Apache License, Version 2.0](./LICENSE-Apache-2.0.txt) We hold no patent rights to anything presented in this repository. ## Credits -The [assets](assets) in this repository are all 3rd-party. See the [credits screen](src/screen/credits.rs) for more information. +The [assets](./assets) in this repository are all 3rd-party. See the [credits screen](./src/screen/credits.rs) for more information. diff --git a/docs/readme-manual-setup.png b/docs/readme-manual-setup.png new file mode 100644 index 00000000..e4a60993 Binary files /dev/null and b/docs/readme-manual-setup.png differ diff --git a/docs/workflow-dispatch-release.png b/docs/workflow-dispatch-release.png new file mode 100644 index 00000000..f7a01f13 Binary files /dev/null and b/docs/workflow-dispatch-release.png differ diff --git a/docs/workflow-secrets.png b/docs/workflow-secrets.png new file mode 100644 index 00000000..3ecfa8f7 Binary files /dev/null and b/docs/workflow-secrets.png differ diff --git a/docs/workflow-settings-permissions.png b/docs/workflow-settings-permissions.png new file mode 100644 index 00000000..9e2ac140 Binary files /dev/null and b/docs/workflow-settings-permissions.png differ diff --git a/docs/workflow-settings.png b/docs/workflow-settings.png new file mode 100644 index 00000000..8636769c Binary files /dev/null and b/docs/workflow-settings.png differ diff --git a/docs/workflows.md b/docs/workflows.md index 1b42d316..298470f1 100644 --- a/docs/workflows.md +++ b/docs/workflows.md @@ -1,6 +1,6 @@ # Bevy Quickstart CI / CD -This template uses [GitHub workflows](https://docs.github.com/en/actions/using-workflows) for [CI / CD](https://www.redhat.com/en/topics/devops/what-is-ci-cd) (defined in [`.github/workflows/`](.github/workflows)). +This template uses [GitHub workflows](https://docs.github.com/en/actions/using-workflows) for [CI / CD](https://www.redhat.com/en/topics/devops/what-is-ci-cd) (defined in [`.github/workflows/`](../.github/workflows)). ## CI (testing) @@ -16,7 +16,7 @@ The [CI workflow](.github/workflows/ci.yaml) will trigger on every commit to `ma ## CD (releasing) -The [CD workflow](.github/workflows/release.yaml) will trigger on every pushed tag in the format `v1.2.3`, and: +The [CD workflow](../.github/workflows/release.yaml) will trigger on every pushed tag in the format `v1.2.3`, and: - Create a release build for Windows, MacOS, Linux, and web. - (Optional) Upload to [GitHub releases](https://docs.github.com/en/repositories/releasing-projects-on-github). @@ -27,7 +27,7 @@ The [CD workflow](.github/workflows/release.yaml) will trigger on every pushed t In your GitHub repository, navigate to `Actions > Release > Run workflow`: -![UI demonstration](TODO) +![UI demonstration](./release-workflow-dispatch.png) Enter a version number in the format `v1.2.3`, then hit the green `Run workflow` button. @@ -37,7 +37,7 @@ Enter a version number in the format `v1.2.3`, then hit the green `Run workflow` ### Set up variables -Open [`.github/workflows/release.yaml`](.github/workflows/release.yaml) and navigate to this section: +Open [`.github/workflows/release.yaml`](../.github/workflows/release.yaml) and navigate to this section: ```yaml env: @@ -65,21 +65,21 @@ Update the values for your project and push a commit. In your GitHub repository, navigate to `Settings > Actions > General`: -![UI demonstration](TODO) +![UI demonstration](./workflow-settings.png) Set `Workflow permissions` to `Read and write permissions`, then hit `Save`: -![UI demonstration](TODO) +![UI demonstration](./workflow-settings-permissions.png) ### Set up itch.io upload -Create your itch.io page with `Kind of project = HTML`, and double-check [`ITCH_TARGET`](#Set-up-variables). +Create your itch.io page with `Kind of project = HTML`, and double-check [`ITCH_TARGET`](#set-up-variables). In your GitHub repository, navigate to `Settings > Secrets and variables > Actions`: -![UI demonstration](TODO) +![UI demonstration](./workflow-secrets.png) Hit `New repository secret` and enter the following, then hit `Add secret`: - **Name:** `BUTLER_CREDENTIALS` -- **Secret:** Your [itch.io API key](https://ithch.io/user/settings/api-keys) (create a new one if necessary) +- **Secret:** Your [itch.io API key](https://itch.io/user/settings/api-keys) (create a new one if necessary)