search

pindell-matt / rust_bucket

Simple JSON key-value store implemented in Rust
Other
11 stars 6 forks source link

Make a basic High Level README #16

Closed selfup closed 8 years ago

selfup commented 8 years ago

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!

cite-reader commented 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.

cite-reader commented 8 years ago

Also may I take this opportunity to evangelize for AsciiDoc? It kind of looks like Markdown, but it's better at its job.

selfup commented 8 years ago

I'll take a look, but markdown rules GitHub. Let me take a look!

selfup commented 8 years ago

I would also take a look at this: https://doc.rust-lang.org/book/comments.html

cargo doc is super powerful

cite-reader commented 8 years ago

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.

selfup commented 8 years ago

Ohh interesting. I'll have to look more into ASCIIDOC.

I would prefer to write things in Markdown just because it seems to be the standard even in the Rust repository itself.