From e357b634482604a3c6b59473847d683cb3e0f76e Mon Sep 17 00:00:00 2001 From: BD103 <59022059+BD103@users.noreply.github.com> Date: Thu, 2 May 2024 14:56:00 -0400 Subject: [PATCH] Add `README.md` to all crates (#13184) # Objective - `README.md` is a common file that usually gives an overview of the folder it is in. - When on , `README.md` is rendered as the main description. - Many crates in this repository are lacking `README.md` files, which makes it more difficult to understand their purpose. image - There are also a few inconsistencies with `README.md` files that this PR and its follow-ups intend to fix. ## Solution - Create a `README.md` file for all crates that do not have one. - This file only contains the title of the crate (underscores removed, proper capitalization, acronyms expanded) and the badges. - Remove the `readme` field in `Cargo.toml` for `bevy` and `bevy_reflect`. - This field is redundant because [Cargo automatically detects `README.md` files](https://doc.rust-lang.org/cargo/reference/manifest.html#the-readme-field). The field is only there if you name it something else, like `INFO.md`. - Fix capitalization of `bevy_utils`'s `README.md`. - It was originally `Readme.md`, which is inconsistent with the rest of the project. - I created two commits renaming it to `README.md`, because Git appears to be case-insensitive. - Expand acronyms in title of `bevy_ptr` and `bevy_utils`. - In the commit where I created all the new `README.md` files, I preferred using expanded acronyms in the titles. (E.g. "Bevy Developer Tools" instead of "Bevy Dev Tools".) - This commit changes the title of existing `README.md` files to follow the same scheme. - I do not feel strongly about this change, please comment if you disagree and I can revert it. - Add badges to `bevy_time` and `bevy_transform`, which are the only crates currently lacking them. --- ## Changelog - Added `README.md` files to all crates missing it. --- Cargo.toml | 1 - crates/bevy_a11y/README.md | 7 +++++++ crates/bevy_animation/README.md | 7 +++++++ crates/bevy_asset/README.md | 7 +++++++ crates/bevy_audio/README.md | 7 +++++++ crates/bevy_color/README.md | 7 +++++++ crates/bevy_core/README.md | 7 +++++++ crates/bevy_core_pipeline/README.md | 7 +++++++ crates/bevy_derive/README.md | 7 +++++++ crates/bevy_dev_tools/README.md | 7 +++++++ crates/bevy_diagnostic/README.md | 7 +++++++ crates/bevy_dylib/README.md | 7 +++++++ crates/bevy_dynamic_plugin/README.md | 7 +++++++ crates/bevy_encase_derive/README.md | 7 +++++++ crates/bevy_gilrs/README.md | 7 +++++++ crates/bevy_gizmos/README.md | 7 +++++++ crates/bevy_gltf/README.md | 7 +++++++ crates/bevy_hierarchy/README.md | 7 +++++++ crates/bevy_input/README.md | 7 +++++++ crates/bevy_internal/README.md | 7 +++++++ crates/bevy_log/README.md | 7 +++++++ crates/bevy_macro_utils/README.md | 7 +++++++ crates/bevy_math/README.md | 7 +++++++ crates/bevy_pbr/README.md | 7 +++++++ crates/bevy_ptr/README.md | 2 +- crates/bevy_reflect/Cargo.toml | 1 - crates/bevy_render/README.md | 7 +++++++ crates/bevy_scene/README.md | 7 +++++++ crates/bevy_sprite/README.md | 7 +++++++ crates/bevy_text/README.md | 7 +++++++ crates/bevy_time/README.md | 6 ++++++ crates/bevy_transform/README.md | 6 ++++++ crates/bevy_ui/README.md | 7 +++++++ crates/bevy_utils/{Readme.md => README.md} | 2 +- crates/bevy_window/README.md | 7 +++++++ crates/bevy_winit/README.md | 7 +++++++ 36 files changed, 224 insertions(+), 4 deletions(-) create mode 100644 crates/bevy_a11y/README.md create mode 100644 crates/bevy_animation/README.md create mode 100644 crates/bevy_asset/README.md create mode 100644 crates/bevy_audio/README.md create mode 100644 crates/bevy_color/README.md create mode 100644 crates/bevy_core/README.md create mode 100644 crates/bevy_core_pipeline/README.md create mode 100644 crates/bevy_derive/README.md create mode 100644 crates/bevy_dev_tools/README.md create mode 100644 crates/bevy_diagnostic/README.md create mode 100644 crates/bevy_dylib/README.md create mode 100644 crates/bevy_dynamic_plugin/README.md create mode 100644 crates/bevy_encase_derive/README.md create mode 100644 crates/bevy_gilrs/README.md create mode 100644 crates/bevy_gizmos/README.md create mode 100644 crates/bevy_gltf/README.md create mode 100644 crates/bevy_hierarchy/README.md create mode 100644 crates/bevy_input/README.md create mode 100644 crates/bevy_internal/README.md create mode 100644 crates/bevy_log/README.md create mode 100644 crates/bevy_macro_utils/README.md create mode 100644 crates/bevy_math/README.md create mode 100644 crates/bevy_pbr/README.md create mode 100644 crates/bevy_render/README.md create mode 100644 crates/bevy_scene/README.md create mode 100644 crates/bevy_sprite/README.md create mode 100644 crates/bevy_text/README.md create mode 100644 crates/bevy_ui/README.md rename crates/bevy_utils/{Readme.md => README.md} (97%) create mode 100644 crates/bevy_window/README.md create mode 100644 crates/bevy_winit/README.md diff --git a/Cargo.toml b/Cargo.toml index 4bd9fce93d..c05a4e52d9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,6 @@ exclude = ["assets/", "tools/", ".github/", "crates/", "examples/wasm/assets/"] homepage = "https://bevyengine.org" keywords = ["game", "engine", "gamedev", "graphics", "bevy"] license = "MIT OR Apache-2.0" -readme = "README.md" repository = "https://github.com/bevyengine/bevy" documentation = "https://docs.rs/bevy" rust-version = "1.77.0" diff --git a/crates/bevy_a11y/README.md b/crates/bevy_a11y/README.md new file mode 100644 index 0000000000..5fca6aea8a --- /dev/null +++ b/crates/bevy_a11y/README.md @@ -0,0 +1,7 @@ +# Bevy A11Y (Accessibility) + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_a11y.svg)](https://crates.io/crates/bevy_a11y) +[![Downloads](https://img.shields.io/crates/d/bevy_a11y.svg)](https://crates.io/crates/bevy_a11y) +[![Docs](https://docs.rs/bevy_a11y/badge.svg)](https://docs.rs/bevy_a11y/latest/bevy_a11y/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_animation/README.md b/crates/bevy_animation/README.md new file mode 100644 index 0000000000..77214264a0 --- /dev/null +++ b/crates/bevy_animation/README.md @@ -0,0 +1,7 @@ +# Bevy Animation + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_animation.svg)](https://crates.io/crates/bevy_animation) +[![Downloads](https://img.shields.io/crates/d/bevy_animation.svg)](https://crates.io/crates/bevy_animation) +[![Docs](https://docs.rs/bevy_animation/badge.svg)](https://docs.rs/bevy_animation/latest/bevy_animation/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_asset/README.md b/crates/bevy_asset/README.md new file mode 100644 index 0000000000..d3b64a43fe --- /dev/null +++ b/crates/bevy_asset/README.md @@ -0,0 +1,7 @@ +# Bevy Asset + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_asset.svg)](https://crates.io/crates/bevy_asset) +[![Downloads](https://img.shields.io/crates/d/bevy_asset.svg)](https://crates.io/crates/bevy_asset) +[![Docs](https://docs.rs/bevy_asset/badge.svg)](https://docs.rs/bevy_asset/latest/bevy_asset/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_audio/README.md b/crates/bevy_audio/README.md new file mode 100644 index 0000000000..7fc893c429 --- /dev/null +++ b/crates/bevy_audio/README.md @@ -0,0 +1,7 @@ +# Bevy Audio + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_audio.svg)](https://crates.io/crates/bevy_audio) +[![Downloads](https://img.shields.io/crates/d/bevy_audio.svg)](https://crates.io/crates/bevy_audio) +[![Docs](https://docs.rs/bevy_audio/badge.svg)](https://docs.rs/bevy_audio/latest/bevy_audio/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_color/README.md b/crates/bevy_color/README.md new file mode 100644 index 0000000000..454a575276 --- /dev/null +++ b/crates/bevy_color/README.md @@ -0,0 +1,7 @@ +# Bevy Color + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_color.svg)](https://crates.io/crates/bevy_color) +[![Downloads](https://img.shields.io/crates/d/bevy_color.svg)](https://crates.io/crates/bevy_color) +[![Docs](https://docs.rs/bevy_color/badge.svg)](https://docs.rs/bevy_color/latest/bevy_color/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_core/README.md b/crates/bevy_core/README.md new file mode 100644 index 0000000000..b1953a959a --- /dev/null +++ b/crates/bevy_core/README.md @@ -0,0 +1,7 @@ +# Bevy Core + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_core.svg)](https://crates.io/crates/bevy_core) +[![Downloads](https://img.shields.io/crates/d/bevy_core.svg)](https://crates.io/crates/bevy_core) +[![Docs](https://docs.rs/bevy_core/badge.svg)](https://docs.rs/bevy_core/latest/bevy_core/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_core_pipeline/README.md b/crates/bevy_core_pipeline/README.md new file mode 100644 index 0000000000..1fafc3b279 --- /dev/null +++ b/crates/bevy_core_pipeline/README.md @@ -0,0 +1,7 @@ +# Bevy Core Pipeline + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_core_pipeline.svg)](https://crates.io/crates/bevy_core_pipeline) +[![Downloads](https://img.shields.io/crates/d/bevy_core_pipeline.svg)](https://crates.io/crates/bevy_core_pipeline) +[![Docs](https://docs.rs/bevy_core_pipeline/badge.svg)](https://docs.rs/bevy_core_pipeline/latest/bevy_core_pipeline/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_derive/README.md b/crates/bevy_derive/README.md new file mode 100644 index 0000000000..fa1246ec1b --- /dev/null +++ b/crates/bevy_derive/README.md @@ -0,0 +1,7 @@ +# Bevy Derive + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_derive.svg)](https://crates.io/crates/bevy_derive) +[![Downloads](https://img.shields.io/crates/d/bevy_derive.svg)](https://crates.io/crates/bevy_derive) +[![Docs](https://docs.rs/bevy_derive/badge.svg)](https://docs.rs/bevy_derive/latest/bevy_derive/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_dev_tools/README.md b/crates/bevy_dev_tools/README.md new file mode 100644 index 0000000000..25cc0e4e30 --- /dev/null +++ b/crates/bevy_dev_tools/README.md @@ -0,0 +1,7 @@ +# Bevy Developer Tools + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_dev_tools.svg)](https://crates.io/crates/bevy_dev_tools) +[![Downloads](https://img.shields.io/crates/d/bevy_dev_tools.svg)](https://crates.io/crates/bevy_dev_tools) +[![Docs](https://docs.rs/bevy_dev_tools/badge.svg)](https://docs.rs/bevy_dev_tools/latest/bevy_dev_tools/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_diagnostic/README.md b/crates/bevy_diagnostic/README.md new file mode 100644 index 0000000000..34c7bd7d51 --- /dev/null +++ b/crates/bevy_diagnostic/README.md @@ -0,0 +1,7 @@ +# Bevy Diagnostic + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_diagnostic.svg)](https://crates.io/crates/bevy_diagnostic) +[![Downloads](https://img.shields.io/crates/d/bevy_diagnostic.svg)](https://crates.io/crates/bevy_diagnostic) +[![Docs](https://docs.rs/bevy_diagnostic/badge.svg)](https://docs.rs/bevy_diagnostic/latest/bevy_diagnostic/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_dylib/README.md b/crates/bevy_dylib/README.md new file mode 100644 index 0000000000..14c7f75323 --- /dev/null +++ b/crates/bevy_dylib/README.md @@ -0,0 +1,7 @@ +# Bevy Dynamic Library + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_dylib.svg)](https://crates.io/crates/bevy_dylib) +[![Downloads](https://img.shields.io/crates/d/bevy_dylib.svg)](https://crates.io/crates/bevy_dylib) +[![Docs](https://docs.rs/bevy_dylib/badge.svg)](https://docs.rs/bevy_dylib/latest/bevy_dylib/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_dynamic_plugin/README.md b/crates/bevy_dynamic_plugin/README.md new file mode 100644 index 0000000000..77b1b39af1 --- /dev/null +++ b/crates/bevy_dynamic_plugin/README.md @@ -0,0 +1,7 @@ +# Bevy Dynamic Plugin + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_dynamic_plugin.svg)](https://crates.io/crates/bevy_dynamic_plugin) +[![Downloads](https://img.shields.io/crates/d/bevy_dynamic_plugin.svg)](https://crates.io/crates/bevy_dynamic_plugin) +[![Docs](https://docs.rs/bevy_dynamic_plugin/badge.svg)](https://docs.rs/bevy_dynamic_plugin/latest/bevy_dynamic_plugin/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_encase_derive/README.md b/crates/bevy_encase_derive/README.md new file mode 100644 index 0000000000..444c006fa0 --- /dev/null +++ b/crates/bevy_encase_derive/README.md @@ -0,0 +1,7 @@ +# Bevy Encase Derive + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_encase_derive.svg)](https://crates.io/crates/bevy_encase_derive) +[![Downloads](https://img.shields.io/crates/d/bevy_encase_derive.svg)](https://crates.io/crates/bevy_encase_derive) +[![Docs](https://docs.rs/bevy_encase_derive/badge.svg)](https://docs.rs/bevy_encase_derive/latest/bevy_encase_derive/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_gilrs/README.md b/crates/bevy_gilrs/README.md new file mode 100644 index 0000000000..083200f7a1 --- /dev/null +++ b/crates/bevy_gilrs/README.md @@ -0,0 +1,7 @@ +# Bevy GilRs + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_gilrs.svg)](https://crates.io/crates/bevy_gilrs) +[![Downloads](https://img.shields.io/crates/d/bevy_gilrs.svg)](https://crates.io/crates/bevy_gilrs) +[![Docs](https://docs.rs/bevy_gilrs/badge.svg)](https://docs.rs/bevy_gilrs/latest/bevy_gilrs/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_gizmos/README.md b/crates/bevy_gizmos/README.md new file mode 100644 index 0000000000..15358bfd3b --- /dev/null +++ b/crates/bevy_gizmos/README.md @@ -0,0 +1,7 @@ +# Bevy Gizmos + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_gizmos.svg)](https://crates.io/crates/bevy_gizmos) +[![Downloads](https://img.shields.io/crates/d/bevy_gizmos.svg)](https://crates.io/crates/bevy_gizmos) +[![Docs](https://docs.rs/bevy_gizmos/badge.svg)](https://docs.rs/bevy_gizmos/latest/bevy_gizmos/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_gltf/README.md b/crates/bevy_gltf/README.md new file mode 100644 index 0000000000..3d567e69ae --- /dev/null +++ b/crates/bevy_gltf/README.md @@ -0,0 +1,7 @@ +# Bevy glTF + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_gltf.svg)](https://crates.io/crates/bevy_gltf) +[![Downloads](https://img.shields.io/crates/d/bevy_gltf.svg)](https://crates.io/crates/bevy_gltf) +[![Docs](https://docs.rs/bevy_gltf/badge.svg)](https://docs.rs/bevy_gltf/latest/bevy_gltf/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_hierarchy/README.md b/crates/bevy_hierarchy/README.md new file mode 100644 index 0000000000..22d7802e9a --- /dev/null +++ b/crates/bevy_hierarchy/README.md @@ -0,0 +1,7 @@ +# Bevy Hierarchy + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_hierarchy.svg)](https://crates.io/crates/bevy_hierarchy) +[![Downloads](https://img.shields.io/crates/d/bevy_hierarchy.svg)](https://crates.io/crates/bevy_hierarchy) +[![Docs](https://docs.rs/bevy_hierarchy/badge.svg)](https://docs.rs/bevy_hierarchy/latest/bevy_hierarchy/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_input/README.md b/crates/bevy_input/README.md new file mode 100644 index 0000000000..41d9e8e1ae --- /dev/null +++ b/crates/bevy_input/README.md @@ -0,0 +1,7 @@ +# Bevy Input + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_input.svg)](https://crates.io/crates/bevy_input) +[![Downloads](https://img.shields.io/crates/d/bevy_input.svg)](https://crates.io/crates/bevy_input) +[![Docs](https://docs.rs/bevy_input/badge.svg)](https://docs.rs/bevy_input/latest/bevy_input/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_internal/README.md b/crates/bevy_internal/README.md new file mode 100644 index 0000000000..9eaf6e1171 --- /dev/null +++ b/crates/bevy_internal/README.md @@ -0,0 +1,7 @@ +# Bevy Internal + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_internal.svg)](https://crates.io/crates/bevy_internal) +[![Downloads](https://img.shields.io/crates/d/bevy_internal.svg)](https://crates.io/crates/bevy_internal) +[![Docs](https://docs.rs/bevy_internal/badge.svg)](https://docs.rs/bevy_internal/latest/bevy_internal/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_log/README.md b/crates/bevy_log/README.md new file mode 100644 index 0000000000..4c627c0772 --- /dev/null +++ b/crates/bevy_log/README.md @@ -0,0 +1,7 @@ +# Bevy Log + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_log.svg)](https://crates.io/crates/bevy_log) +[![Downloads](https://img.shields.io/crates/d/bevy_log.svg)](https://crates.io/crates/bevy_log) +[![Docs](https://docs.rs/bevy_log/badge.svg)](https://docs.rs/bevy_log/latest/bevy_log/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_macro_utils/README.md b/crates/bevy_macro_utils/README.md new file mode 100644 index 0000000000..6ea2a00760 --- /dev/null +++ b/crates/bevy_macro_utils/README.md @@ -0,0 +1,7 @@ +# Bevy Macro Utilities + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_macro_utils.svg)](https://crates.io/crates/bevy_macro_utils) +[![Downloads](https://img.shields.io/crates/d/bevy_macro_utils.svg)](https://crates.io/crates/bevy_macro_utils) +[![Docs](https://docs.rs/bevy_macro_utils/badge.svg)](https://docs.rs/bevy_macro_utils/latest/bevy_macro_utils/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_math/README.md b/crates/bevy_math/README.md new file mode 100644 index 0000000000..932f4cd416 --- /dev/null +++ b/crates/bevy_math/README.md @@ -0,0 +1,7 @@ +# Bevy Math + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_math.svg)](https://crates.io/crates/bevy_math) +[![Downloads](https://img.shields.io/crates/d/bevy_math.svg)](https://crates.io/crates/bevy_math) +[![Docs](https://docs.rs/bevy_math/badge.svg)](https://docs.rs/bevy_math/latest/bevy_math/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_pbr/README.md b/crates/bevy_pbr/README.md new file mode 100644 index 0000000000..c65a6a11d2 --- /dev/null +++ b/crates/bevy_pbr/README.md @@ -0,0 +1,7 @@ +# Bevy PBR + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_pbr.svg)](https://crates.io/crates/bevy_pbr) +[![Downloads](https://img.shields.io/crates/d/bevy_pbr.svg)](https://crates.io/crates/bevy_pbr) +[![Docs](https://docs.rs/bevy_pbr/badge.svg)](https://docs.rs/bevy_pbr/latest/bevy_pbr/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_ptr/README.md b/crates/bevy_ptr/README.md index b422f0be9d..cce9b80f29 100644 --- a/crates/bevy_ptr/README.md +++ b/crates/bevy_ptr/README.md @@ -1,4 +1,4 @@ -# Bevy Ptr +# Bevy Pointer [![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) [![Crates.io](https://img.shields.io/crates/v/bevy_ptr.svg)](https://crates.io/crates/bevy_ptr) diff --git a/crates/bevy_reflect/Cargo.toml b/crates/bevy_reflect/Cargo.toml index 96b9384d88..212463d3e3 100644 --- a/crates/bevy_reflect/Cargo.toml +++ b/crates/bevy_reflect/Cargo.toml @@ -7,7 +7,6 @@ homepage = "https://bevyengine.org" repository = "https://github.com/bevyengine/bevy" license = "MIT OR Apache-2.0" keywords = ["bevy"] -readme = "README.md" [features] default = ["smallvec"] diff --git a/crates/bevy_render/README.md b/crates/bevy_render/README.md new file mode 100644 index 0000000000..0106a5ca1f --- /dev/null +++ b/crates/bevy_render/README.md @@ -0,0 +1,7 @@ +# Bevy Render + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_render.svg)](https://crates.io/crates/bevy_render) +[![Downloads](https://img.shields.io/crates/d/bevy_render.svg)](https://crates.io/crates/bevy_render) +[![Docs](https://docs.rs/bevy_render/badge.svg)](https://docs.rs/bevy_render/latest/bevy_render/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_scene/README.md b/crates/bevy_scene/README.md new file mode 100644 index 0000000000..4508aefe66 --- /dev/null +++ b/crates/bevy_scene/README.md @@ -0,0 +1,7 @@ +# Bevy Scene + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_scene.svg)](https://crates.io/crates/bevy_scene) +[![Downloads](https://img.shields.io/crates/d/bevy_scene.svg)](https://crates.io/crates/bevy_scene) +[![Docs](https://docs.rs/bevy_scene/badge.svg)](https://docs.rs/bevy_scene/latest/bevy_scene/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_sprite/README.md b/crates/bevy_sprite/README.md new file mode 100644 index 0000000000..bc1b483d41 --- /dev/null +++ b/crates/bevy_sprite/README.md @@ -0,0 +1,7 @@ +# Bevy Sprite + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_sprite.svg)](https://crates.io/crates/bevy_sprite) +[![Downloads](https://img.shields.io/crates/d/bevy_sprite.svg)](https://crates.io/crates/bevy_sprite) +[![Docs](https://docs.rs/bevy_sprite/badge.svg)](https://docs.rs/bevy_sprite/latest/bevy_sprite/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_text/README.md b/crates/bevy_text/README.md new file mode 100644 index 0000000000..af5c1608db --- /dev/null +++ b/crates/bevy_text/README.md @@ -0,0 +1,7 @@ +# Bevy Text + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_text.svg)](https://crates.io/crates/bevy_text) +[![Downloads](https://img.shields.io/crates/d/bevy_text.svg)](https://crates.io/crates/bevy_text) +[![Docs](https://docs.rs/bevy_text/badge.svg)](https://docs.rs/bevy_text/latest/bevy_text/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_time/README.md b/crates/bevy_time/README.md index 3b5652cd1d..6ea5ff9eeb 100644 --- a/crates/bevy_time/README.md +++ b/crates/bevy_time/README.md @@ -1,3 +1,9 @@ # Bevy Time +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy.svg)](https://crates.io/crates/bevy_time) +[![Downloads](https://img.shields.io/crates/d/bevy_time.svg)](https://crates.io/crates/bevy_time) +[![Docs](https://docs.rs/bevy_time/badge.svg)](https://docs.rs/bevy_time/latest/bevy_time/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) + The built-in timekeeping plugin for the Bevy game engine. diff --git a/crates/bevy_transform/README.md b/crates/bevy_transform/README.md index 9f917c5460..c291b45e9b 100644 --- a/crates/bevy_transform/README.md +++ b/crates/bevy_transform/README.md @@ -1,3 +1,9 @@ # Bevy Transform +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy.svg)](https://crates.io/crates/bevy_transform) +[![Downloads](https://img.shields.io/crates/d/bevy_transform.svg)](https://crates.io/crates/bevy_transform) +[![Docs](https://docs.rs/bevy_transform/badge.svg)](https://docs.rs/bevy_transform/latest/bevy_transform/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) + This crate contains types and functions associated with the `Transform` component. diff --git a/crates/bevy_ui/README.md b/crates/bevy_ui/README.md new file mode 100644 index 0000000000..3a5d601fc3 --- /dev/null +++ b/crates/bevy_ui/README.md @@ -0,0 +1,7 @@ +# Bevy UI + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_ui.svg)](https://crates.io/crates/bevy_ui) +[![Downloads](https://img.shields.io/crates/d/bevy_ui.svg)](https://crates.io/crates/bevy_ui) +[![Docs](https://docs.rs/bevy_ui/badge.svg)](https://docs.rs/bevy_ui/latest/bevy_ui/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_utils/Readme.md b/crates/bevy_utils/README.md similarity index 97% rename from crates/bevy_utils/Readme.md rename to crates/bevy_utils/README.md index a1eb221eb6..341755babc 100644 --- a/crates/bevy_utils/Readme.md +++ b/crates/bevy_utils/README.md @@ -1,4 +1,4 @@ -# Bevy Utils +# Bevy Utilities [![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) [![Crates.io](https://img.shields.io/crates/v/bevy.svg)](https://crates.io/crates/bevy_utils) diff --git a/crates/bevy_window/README.md b/crates/bevy_window/README.md new file mode 100644 index 0000000000..f450fc55d3 --- /dev/null +++ b/crates/bevy_window/README.md @@ -0,0 +1,7 @@ +# Bevy Window + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_name.svg)](https://crates.io/crates/bevy_name) +[![Downloads](https://img.shields.io/crates/d/bevy_name.svg)](https://crates.io/crates/bevy_name) +[![Docs](https://docs.rs/bevy_name/badge.svg)](https://docs.rs/bevy_name/latest/bevy_name/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy) diff --git a/crates/bevy_winit/README.md b/crates/bevy_winit/README.md new file mode 100644 index 0000000000..2e7c9b77a7 --- /dev/null +++ b/crates/bevy_winit/README.md @@ -0,0 +1,7 @@ +# Bevy Winit + +[![License](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/bevyengine/bevy#license) +[![Crates.io](https://img.shields.io/crates/v/bevy_name.svg)](https://crates.io/crates/bevy_name) +[![Downloads](https://img.shields.io/crates/d/bevy_name.svg)](https://crates.io/crates/bevy_name) +[![Docs](https://docs.rs/bevy_name/badge.svg)](https://docs.rs/bevy_name/latest/bevy_name/) +[![Discord](https://img.shields.io/discord/691052431525675048.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/bevy)