Skip to content

Commit 569024a

Browse files
committed
lib: include README as doc
Caveats: Further referenced local markdown files are not included automatically. While it would be possible to add more `#![doc = ...]` for `docs/*md`, they would simply be appended to the README, so that links would only work as #-references. Also, images are not included. Those are known issues in Rustdoc, and existing workarounds would be complicated to add. We expect readers to look at the repository's markdown rendering instead. Signed-off-by: Daniel Maslowski <[email protected]>
1 parent fe6a3ae commit 569024a

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

src/lib.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
#![doc = include_str!("../README.md")]
2+
13
use core::mem;
24
use log::{error, warn};
35

0 commit comments

Comments
 (0)