From e243175d272dc220daa567e924f3da7df9584c8e Mon Sep 17 00:00:00 2001 From: Nicola Papale Date: Mon, 17 Apr 2023 18:13:24 +0200 Subject: [PATCH] Add examples page build instructions (#8413) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit # Objective Bevy provides an easy way to build the `examples/README.md` page, but it's difficult to discover. By adding instructions in `CONTRIBUTING.md`, it's easier to find that it's possible to avoid this error-prone manual process. Precisely: #8405 took me about 1 additional hour searching what command to use to generate automatically the file. (I could have manually edited the README, but that's beyond the point…) --- CONTRIBUTING.md | 1 + docs-template/EXAMPLE_README.md.tpl | 1 + examples/README.md | 1 + 3 files changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 43e44f537d..77e190abd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -265,6 +265,7 @@ Examples in Bevy should be: 4. **Minimal:** They should be no larger or complex than is needed to meet the goals of the example. When you add a new example, be sure to update `examples/README.md` with the new example and add it to the root `Cargo.toml` file. +Run `cargo run -p build-templated-pages -- build-example-page` to do this automatically. Use a generous sprinkling of keywords in your description: these are commonly used to search for a specific example. See the [example style guide](.github/contributing/example_style_guide.md) to help make sure the style of your example matches what we're already using. diff --git a/docs-template/EXAMPLE_README.md.tpl b/docs-template/EXAMPLE_README.md.tpl index 19e0007274..5b25037209 100644 --- a/docs-template/EXAMPLE_README.md.tpl +++ b/docs-template/EXAMPLE_README.md.tpl @@ -1,4 +1,5 @@ + # Examples diff --git a/examples/README.md b/examples/README.md index e96a5d1b58..d55f75ee1e 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,4 +1,5 @@ + # Examples