diff --git a/docs/cargo_features.md b/docs/cargo_features.md index a2df4f8177..c2f0fdc1a7 100644 --- a/docs/cargo_features.md +++ b/docs/cargo_features.md @@ -5,7 +5,7 @@ |feature name|description| |-|-| |bevy_audio|Audio support. Support for all audio formats depends on this.| -|bevy_dynamic_plugins|Plugins for dynamic loading (libloading)| +|bevy_dynamic_plugins|Plugins for dynamic loading (libloading).| |bevy_gilrs|Adds gamepad support.| |bevy_gltf|[glTF](https://www.khronos.org/gltf/) support.| |bevy_winit|GUI support.| @@ -20,7 +20,7 @@ |feature name|description| |-|-| -|trace|Enables system tracing (useful in tandem wit a feature like trace_chrome)| +|trace|Enables system tracing (useful in tandem wit a feature like trace_chrome).| |trace_chrome|Enables [tracing-chrome](https://github.com/thoren-d/tracing-chrome) as bevy_log output. This allows you to visualize system execution.| |wgpu_trace|For tracing wgpu.| |flac|FLAC audio format support. It's included in bevy_audio feature.| diff --git a/docs/linux_dependencies.md b/docs/linux_dependencies.md index 09646fe845..d56ff72efc 100644 --- a/docs/linux_dependencies.md +++ b/docs/linux_dependencies.md @@ -9,7 +9,7 @@ If you don't see your distro present in the list, feel free to add the instructi ```bash sudo apt-get install pkg-config libx11-dev libasound2-dev libudev-dev ``` -If you want to Enable Fast Compiles +If you want to enable fast compiles ```bash sudo apt-get install clang ``` @@ -55,7 +55,7 @@ fn main() { } ``` -The following packages are known to provide the dependencies required to run a bevy project. They can be installed globally or via nix-shell. +These packages provide the dependencies required to run a bevy project. They can be installed globally or via nix-shell. `nix-shell -p pkgconfig x11 xorg.libXcursor xorg.libXrandr xorg.libXi vulkan-tools lutris vulkan-headers vulkan-loader vulkan-validation-layers alsaLib` diff --git a/docs/plugins_guidelines.md b/docs/plugins_guidelines.md index 2f87abc7d9..c2689a919d 100644 --- a/docs/plugins_guidelines.md +++ b/docs/plugins_guidelines.md @@ -20,15 +20,15 @@ This document targets plugin authors. ## Naming -You are free to use a `bevy_xxx` name for your plugin, with the caveat "please be reasonable". If you are about to claim a generic name like `bevy_animation`, `bevy_color`, or `bevy_editor`... please ask first. The rational is explained [here](https://github.com/bevyengine/bevy/discussions/1202#discussioncomment-258907). +You are free to use a `bevy_xxx` name for your plugin, but please be reasonable. If you are about to claim a generic name like `bevy_animation`, `bevy_color`, or `bevy_editor`, please ask first. The rationale is explained [here](https://github.com/bevyengine/bevy/discussions/1202#discussioncomment-258907). ## Promotion You can promote your plugin in Bevy's [communities](https://github.com/bevyengine/bevy#community): -* Add it to [Awesome Bevy](https://github.com/bevyengine/awesome-bevy) -* Announce it on [Discord](https://discord.gg/gMUk5Ph), in channel `#showcase` -* Announce it on [Reddit](https://reddit.com/r/bevy) +* Add it to [Awesome Bevy](https://github.com/bevyengine/awesome-bevy). +* Announce it on [Discord](https://discord.gg/gMUk5Ph), in the `#showcase` channel. +* Announce it on [Reddit](https://reddit.com/r/bevy). ## Bevy Version Supported @@ -48,7 +48,7 @@ bevy = { version = "0.4", default-features = false, features = ["..."] } ## Master Branch Tracking -If you intend to track Bevy's master branch, you can specify the latest commit you support in your cargo.toml file: +If you intend to track Bevy's master branch, you can specify the latest commit you support in your `Cargo.toml` file: ``` bevy = { version = "0.4", git = "https://github.com/bevyengine/bevy", rev="509b138e8fa3ea250393de40c33cc857c72134d3", default-features = false } ```