Skip to content

Commit 87f509f

Browse files
committed
add docs about another way to enable bevy_dev_tools
1 parent 078d730 commit 87f509f

File tree

1 file changed

+9
-1
lines changed
  • crates/bevy_dev_tools/src

1 file changed

+9
-1
lines changed

crates/bevy_dev_tools/src/lib.rs

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ pub mod ci_testing;
1515
///
1616
/// To enable developer tools, you can either:
1717
///
18+
/// - Create a custom crate feature (e.g "dev_mode"), which enables the `bevy_dev_tools` feature
19+
/// along with any other development tools you might be using:
20+
///
21+
/// ```toml
22+
/// [feature]
23+
/// dev_mode = ["bevy/bevy_dev_tools", "other_dev_tools"]
24+
/// ```
25+
///
1826
/// - Use `--feature bevy/bevy_dev_tools` flag when using the `cargo run` command:
1927
///
2028
/// `cargo run --features bevy/bevy_dev_tools`
@@ -23,7 +31,7 @@ pub mod ci_testing;
2331
///
2432
/// `features = ["bevy_dev_tools"]`
2533
///
26-
/// Note: The second method is not recommended, as it requires you to remove the feature before
34+
/// Note: The third method is not recommended, as it requires you to remove the feature before
2735
/// creating a build for release to the public.
2836
pub struct DevToolsPlugin;
2937

0 commit comments

Comments
 (0)