Add readme as docs to relevant crates.

bevyengine · Jul 31, 2021 · 2c1e4c8 · 2c1e4c8
1 parent 54ff7aa
commit 2c1e4c8
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/crates/bevy_ecs/src/lib.rs b/crates/bevy_ecs/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 pub mod archetype;
 pub mod bundle;
 pub mod change_detection;

diff --git a/crates/bevy_reflect/src/lib.rs b/crates/bevy_reflect/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 mod list;
 mod map;
 mod path;

diff --git a/crates/bevy_tasks/src/lib.rs b/crates/bevy_tasks/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 mod slice;
 pub use slice::{ParallelSlice, ParallelSliceMut};
 

diff --git a/crates/bevy_transform/src/lib.rs b/crates/bevy_transform/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 pub mod components;
 pub mod hierarchy;
 pub mod transform_propagate_system;