Skip to content

Modifying the readme in example to address the wayland default #21411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+12 −0
Open

Modifying the readme in example to address the wayland default #21411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
225713f
Modifying the readme in example to address the wayland default
Oct 6, 2025
8e2e425
Merge branch 'main' into edit_example_readme
Oct 6, 2025
7bf6b21
Fenced code blocks surrounded by blank lines
Oct 6, 2025
722ef06
Made the actual change required thnx CatThingy
Oct 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs-template/EXAMPLE_README.md.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ To run an example, use the command `cargo run --example <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!
Expand Down
6 changes: 6 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ To run an example, use the command `cargo run --example <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!
Expand Down