remove generate-readme #68
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
It is preferable to have documentation in one place. We have been using cargo-readme via generate-readme to copy the documentation from lib.rs and main.rs files to a superfluous README.md file. This commit removes that duplication and the package and build.rs files that generated it.
bcressey
approved these changes
Sep 19, 2023
jpculp
approved these changes
Sep 19, 2023
ecpullen
approved these changes
Sep 19, 2023
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.
Issue #, if available:
Closes #39
Description of changes:
It is preferable to have documentation in one place. We have been using cargo-readme via generate-readme to copy the documentation from lib.rs and main.rs files to a superfluous README.md file. This commit removes that duplication and the package and build.rs files that generated it.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.