-
Notifications
You must be signed in to change notification settings - Fork 216
separate README.md's #463
Copy link
Copy link
Closed
Labels
good first issueGood for a first contributorGood for a first contributorhelp wantedNo clear candidate to implement itNo clear candidate to implement itr-docsrelated to documentationrelated to documentation
Milestone
Description
Activity
Metadata
Metadata
Assignees
Labels
good first issueGood for a first contributorGood for a first contributorhelp wantedNo clear candidate to implement itNo clear candidate to implement itr-docsrelated to documentationrelated to documentation
implement a clear separation of concerns regarding READMEs in the repository
on one hand
./README.mdshould be the README that ships with Cargo and shows up at crates.io and is the "this is what this crate is" READMEon the other hand
./.github/README.md, a README intended for contributors that are visiting the GitHub repolet's keep the split simple for now: remove the important quote block from the current readme and make the new one have it