search

openwsn-berkeley / lakers

EDHOC implemented in Rust, optimized for microcontrollers, with bindings for C and Python.
https://crates.io/crates/lakers
BSD 3-Clause "New" or "Revised" License
13 stars 10 forks source link

doc: Add README for shared, and link READMEs in the crates #175

Closed chrysn closed 9 months ago

chrysn commented 9 months ago

This should fix the big looming "appears to have no README.md file" texts on crates.io. I don't think we can really test this other than wait what it looks like after the next release, but the absense of "unused manifest key" warnings in a cargo check is a good sign.

The main crate just uses the top-level README; all others use a shared one that points to the main crate.

geonnave commented 9 months ago

Thank you for this PR, it looks good. Left one minor comment.

chrysn commented 9 months ago

why it points to the README of the shared crate?

Because it fast-forwards the user to the relevant main crate with the overview documentation. Several crates with all the same text (and the user won't know unless they diff, maybe the detail is somewhere down) are confusing to users. The shared README is ... well, shared among all other crates :-) and is just that: a pointer that says it's part of the big thing.

geonnave commented 9 months ago

I see, then it can just be overridden when crate-specific READMEs are added. Cool!