Add full readme to crate documentation

oli-obk · Aug 6, 2024 · 034c64d · 034c64d
1 parent a1afa5e
commit 034c64d
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -5,8 +5,11 @@
     rustc::internal
 )]
 #![deny(missing_docs)]
-
-//! A crate to run the Rust compiler (or other binaries) and test their command line output.
+#![cfg_attr(doc, doc = include_str!("../README.md"))]
+#![cfg_attr(
+    not(doc),
+    doc = "A crate to run the Rust compiler (or other binaries) and test their command line output."
+)]
 
 use build_manager::BuildManager;
 pub use color_eyre;