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 2 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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 Macros is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
4 changes: 3 additions & 1 deletion crates/bevy_time/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Bevy Time

The built-in timekeeping plugin for the Bevy game engine.
The built-in timekeeping plugin for the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).

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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).
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 is a component of the [Bevy Engine](https://bevyengine.org/).

It is not intended for independent use, use it only as a part of [Bevy](https://crates.io/crates/bevy).