diff --git a/.github/example-run/headless_defaults.ron b/.github/example-run/no_renderer.ron similarity index 100% rename from .github/example-run/headless_defaults.ron rename to .github/example-run/no_renderer.ron diff --git a/Cargo.toml b/Cargo.toml index be00c9e7c1774..80b0e8915dca7 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -594,12 +594,12 @@ category = "Application" wasm = false [[example]] -name = "headless_defaults" -path = "examples/app/headless_defaults.rs" +name = "no_renderer" +path = "examples/app/no_renderer.rs" -[package.metadata.example.headless_defaults] -name = "Headless with Defaults" -description = "An application that runs with default plugins, but without an actual renderer" +[package.metadata.example.no_renderer] +name = "No Renderer" +description = "An application that runs with default plugins and displays an empty window, but without an actual renderer" category = "Application" wasm = false diff --git a/examples/README.md b/examples/README.md index 98ebc75235639..9769576a7dd4a 100644 --- a/examples/README.md +++ b/examples/README.md @@ -143,8 +143,8 @@ Example | Description [Empty](../examples/app/empty.rs) | An empty application (does nothing) [Empty with Defaults](../examples/app/empty_defaults.rs) | An empty application with default plugins [Headless](../examples/app/headless.rs) | An application that runs without default plugins -[Headless with Defaults](../examples/app/headless_defaults.rs) | An application that runs with default plugins, but without an actual renderer [Logs](../examples/app/logs.rs) | Illustrate how to use generate log output +[No Renderer](../examples/app/no_renderer.rs) | An application that runs with default plugins and displays an empty window, but without an actual renderer [Plugin](../examples/app/plugin.rs) | Demonstrates the creation and registration of a custom plugin [Plugin Group](../examples/app/plugin_group.rs) | Demonstrates the creation and registration of a custom plugin group [Return after Run](../examples/app/return_after_run.rs) | Show how to return to main after the Bevy app has exited diff --git a/examples/app/headless_defaults.rs b/examples/app/no_renderer.rs similarity index 61% rename from examples/app/headless_defaults.rs rename to examples/app/no_renderer.rs index 72dbeba5ea383..ef6ef38c976db 100644 --- a/examples/app/headless_defaults.rs +++ b/examples/app/no_renderer.rs @@ -1,5 +1,8 @@ -//! An application that runs with default plugins, but without an actual renderer. +//! An application that runs with default plugins and displays an empty +//! window, but without an actual renderer. //! This can be very useful for integration tests or CI. +//! +//! See also the `headless` example which does not display a window. use bevy::{prelude::*, render::settings::WgpuSettings};