This puts a # Heading into the rustdoc, which is very slightly ugly -- it's fine, by all means go ahead.
An alternative way to do this is to use cargo install cargo-readme then cargo readme > README.md, plus I guess some scripting and lints to support the practice.
This puts a
# Headinginto the rustdoc, which is very slightly ugly -- it's fine, by all means go ahead.An alternative way to do this is to use
cargo install cargo-readmethencargo readme > README.md, plus I guess some scripting and lints to support the practice.