Fix README not rendering on cargo.io #15
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The README isn't rendering for the crate in cargo.io. This should fix it by symbolically linking it into the crate. This is the same approach as to how https://github.com/serde-rs/serde/tree/master/serde handles the same problem.
An alternative I considered is having the
Cargo.tomlfile use a relative path to get the README but then the README file isn't uploaded inside the crate whereas the symlinking approach appears to result in it being in the crate (see https://docs.rs/crate/serde/1.0.11/source/README.md).