Closed selfup closed 8 years ago
+1 for prioritizing this; I don't have a strong understanding of high-level goals myself so I'm basically restricted to doing the pinhole optimizer thing.
Also may I take this opportunity to evangelize for AsciiDoc? It kind of looks like Markdown, but it's better at its job.
I'll take a look, but markdown rules GitHub. Let me take a look!
I would also take a look at this: https://doc.rust-lang.org/book/comments.html
cargo doc
is super powerful
Oh, for documenting the code rustdoc is definitely the correct choice, which locks you into Markdown. That's not true for the README though, especially since github understands and renders ASCIIDOC.
This will help people that accidentally stumble upon this repo, prior to us pushing it to https://crates.io when we turn this into a crate, understand that it is a work in progress!