Skip to content
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.

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

Add READMEs to all crates and clarify they are part of Bevy #9995

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
5 changes: 5 additions & 0 deletions crates/bevy_a11y/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy A11Y

[Bevy A11Y](https://github.com/bevyengine/bevy/tree/main/crates/bevy_a11y) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).
ameknite marked this conversation as resolved.
Show resolved Hide resolved

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_animation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Animation

[Bevy Animation](https://github.com/bevyengine/bevy/tree/main/crates/bevy_animation) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy App

[Bevy App](https://github.com/bevyengine/bevy/tree/main/crates/bevy_app) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
alice-i-cecile marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 5 additions & 0 deletions crates/bevy_asset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Asset

[Bevy Asset](https://github.com/bevyengine/bevy/tree/main/crates/bevy_asset) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_asset/macros/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Asset Macros

[Bevy Asset Macros)](https://github.com/bevyengine/bevy/tree/main/crates/bevy_asset/macros) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_audio/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Audio

[Bevy Audio](https://github.com/bevyengine/bevy/tree/main/crates/bevy_audio) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Core

[Bevy Core](https://github.com/bevyengine/bevy/tree/main/crates/bevy_core) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_core_pipeline/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Core Pipeline

[Bevy Core Pipeline](https://github.com/bevyengine/bevy/tree/main/crates/bevy_core_pipeline) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_derive/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Derive

[Bevy Derive](https://github.com/bevyengine/bevy/tree/main/crates/bevy_derive) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_diagnostic/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Diagnostic

[Bevy Diagnostic](https://github.com/bevyengine/bevy/tree/main/crates/bevy_diagnostic) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_dylib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy DyLib

[Bevy DyLib](https://github.com/bevyengine/bevy/tree/main/crates/bevy_dylib) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_dynamic_plugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Dynamic Plugin

[Bevy Dynamic Plugin](https://github.com/bevyengine/bevy/tree/main/crates/bevy_dynamic_plugin) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_ecs/macros/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy ECS Macros

[Bevy Ecs Macros](https://github.com/bevyengine/bevy/tree/main/crates/bevy_ecs/macros) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_encase_derive/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Encase Derive

[Bevy Encase Derive](https://github.com/bevyengine/bevy/tree/main/crates/bevy_encase_derive) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_gilrs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy GilRs

[Bevy GilRs](https://github.com/bevyengine/bevy/tree/main/crates/bevy_gilrs) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_gizmos/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Gizmos

[Bevy Gizmos](https://github.com/bevyengine/bevy/tree/main/crates/bevy_gizmos) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_gltf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy GLTF

[Bevy GLTF](https://github.com/bevyengine/bevy/tree/main/crates/bevy_gltf) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_hierarchy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Hierarchy

[Bevy Hierarchy](https://github.com/bevyengine/bevy/tree/main/crates/bevy_hierarchy) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_input/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Input

[Bevy Input](https://github.com/bevyengine/bevy/tree/main/crates/bevy_input) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_internal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Internal

[Bevy Internal](https://github.com/bevyengine/bevy/tree/main/crates/bevy_internal) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_log/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Log

[Bevy Log](https://github.com/bevyengine/bevy/tree/main/crates/bevy_log) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_macro_utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Macro Utils

[Bevy Macro Utils](https://github.com/bevyengine/bevy/tree/main/crates/bevy_macro_utils) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_math/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Math

[Bevy Math](https://github.com/bevyengine/bevy/tree/main/crates/bevy_math) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_pbr/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy PBR

[Bevy PBR](https://github.com/bevyengine/bevy/tree/main/crates/bevy_pbr) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_reflect/bevy_reflect_derive/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Reflect Derive

Bevy Reflect Derive is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_render/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Render

[Bevy Render](https://github.com/bevyengine/bevy/tree/main/crates/bevy_render) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_render/macros/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Render Macros

[Bevy Render](https://github.com/bevyengine/bevy/tree/main/crates/bevy_render/macros) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_scene/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Scene

[Bevy Scene](https://github.com/bevyengine/bevy/tree/main/crates/bevy_scene) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_sprite/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Sprite

[Bevy Sprite](https://github.com/bevyengine/bevy/tree/main/crates/bevy_sprite) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_text/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Text

[Bevy Text](https://github.com/bevyengine/bevy/tree/main/crates/bevy_text) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
4 changes: 4 additions & 0 deletions crates/bevy_time/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Bevy Time

The built-in timekeeping plugin for the Bevy game engine.

[Bevy Time](https://github.com/bevyengine/bevy/tree/main/crates/bevy_time) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
6 changes: 5 additions & 1 deletion crates/bevy_transform/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# Bevy Transform

This crate is largely a 1:1 port from [legion_transform](https://github.com/AThilenius/legion_transform) (ecs: legion, math: nalgebra) to bevy (ecs: bevy_ecs, math: glam)
[Bevy Transform](https://github.com/bevyengine/bevy/tree/main/crates/bevy_transform) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.

This crate is largely a 1:1 port from [legion_transform](https://github.com/AThilenius/legion_transform) (ecs: legion, math: nalgebra) to bevy (ecs: bevy_ecs, math: glam).
5 changes: 5 additions & 0 deletions crates/bevy_ui/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy UI

[Bevy UI](https://github.com/bevyengine/bevy/tree/main/crates/bevy_ui) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_utils/macros/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Utils Proc Macros

[Bevy Utils Proc Macros](https://github.com/bevyengine/bevy/tree/main/crates/bevy_utils/macros) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_window/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Window

[Bevy Window](https://github.com/bevyengine/bevy/tree/main/crates/bevy_window) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.
5 changes: 5 additions & 0 deletions crates/bevy_winit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Bevy Winit

[Bevy Winit](https://github.com/bevyengine/bevy/tree/main/crates/bevy_winit) is a component of the [Bevy Engine](https://bevyengine.org/). You can revise the list of official crates [here](https://github.com/bevyengine/bevy/tree/main/crates).

This crate is intended to be used as a part of [Bevy](https://crates.io/crates/bevy) and not independently. However, feel free to use it if it fits your needs.