From 225713f3e752467eb6b43a90792798e056df1386 Mon Sep 17 00:00:00 2001 From: Vivek Naik Date: Mon, 6 Oct 2025 08:25:32 +0530 Subject: [PATCH 1/3] Modifying the readme in example to address the wayland default --- examples/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/examples/README.md b/examples/README.md index 5ad5ef2fa69c6..9b5edd7304671 100644 --- a/examples/README.md +++ b/examples/README.md @@ -10,7 +10,10 @@ To run an example, use the command `cargo run --example `, and add the ```sh cargo run --features wayland --example hello_world ``` - +Because the engine builds with wayland by default, if your system uses x11, you need to add `--no-default-features` flag. Run using this command: +```sh +cargo run --no-default-features --features x11 --example hello_world +``` **⚠️ Note: for users of releases on crates.io!** There are often large differences and incompatible API changes between the latest [crates.io](https://crates.io/crates/bevy) release and the development version of Bevy in the git main branch! From 7bf6b211e0083377c6168ae392e3b9b4e1bb2af2 Mon Sep 17 00:00:00 2001 From: Vivek Naik Date: Tue, 7 Oct 2025 05:23:00 +0530 Subject: [PATCH 2/3] Fenced code blocks surrounded by blank lines --- examples/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/examples/README.md b/examples/README.md index 9b5edd7304671..6838c94d8babb 100644 --- a/examples/README.md +++ b/examples/README.md @@ -10,10 +10,13 @@ To run an example, use the command `cargo run --example `, and add the ```sh cargo run --features wayland --example hello_world ``` + Because the engine builds with wayland by default, if your system uses x11, you need to add `--no-default-features` flag. Run using this command: + ```sh cargo run --no-default-features --features x11 --example hello_world ``` + **⚠️ Note: for users of releases on crates.io!** There are often large differences and incompatible API changes between the latest [crates.io](https://crates.io/crates/bevy) release and the development version of Bevy in the git main branch! From 722ef06a99cc84844b5262fd42578307276a6b7b Mon Sep 17 00:00:00 2001 From: Vivek Naik Date: Tue, 7 Oct 2025 05:43:40 +0530 Subject: [PATCH 3/3] Made the actual change required thnx CatThingy --- docs-template/EXAMPLE_README.md.tpl | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs-template/EXAMPLE_README.md.tpl b/docs-template/EXAMPLE_README.md.tpl index e1300061978b9..6b892f8201d7c 100644 --- a/docs-template/EXAMPLE_README.md.tpl +++ b/docs-template/EXAMPLE_README.md.tpl @@ -11,6 +11,12 @@ To run an example, use the command `cargo run --example `, and add the cargo run --features wayland --example hello_world ``` +Because the engine builds with wayland by default, if your system uses x11, you need to add `--no-default-features` flag. Run using this command: + +```sh +cargo run --no-default-features --features x11 --example hello_world +``` + **⚠️ Note: for users of releases on crates.io!** There are often large differences and incompatible API changes between the latest [crates.io](https://crates.io/crates/bevy) release and the development version of Bevy in the git main branch!