Use README as documented's module level documentation

This also makes `documented-test::readme` entirely unnecessary
cyqsimon · Oct 21, 2024 · 1ab4d0b · 1ab4d0b
1 parent 10a817e
commit 1ab4d0b
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 59 deletions.
diff --git a/documented-test/build.rs b/documented-test/build.rs
diff --git a/documented-test/src/lib.rs b/documented-test/src/lib.rs
@@ -2,4 +2,3 @@
 
 mod attr;
 mod derive;
-mod readme;
diff --git a/documented-test/src/readme.rs b/documented-test/src/readme.rs
diff --git a/lib/src/lib.rs b/lib/src/lib.rs
@@ -1,3 +1,5 @@
+#![doc = include_str!("../../README.md")]
+
 pub use documented_macros::{
     docs_const, Documented, DocumentedFields, DocumentedFieldsOpt, DocumentedOpt,
     DocumentedVariants, DocumentedVariantsOpt,