Use godocdown to create a github-friendly readme #21
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
This commit adds a script 'update_readme.sh' that generates github-friendly markdown using godocdown. When the documentation for the readme for github should be updated because the package or package's documentation changes, run: sh update_readme.sh to update README.md. This commit is meant to be the first step in addressing #3.
|
Awesome! This is a great solution to the lack of a readme, |
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.
This commit adds a script 'update_readme.sh' that generates
github-friendly markdown using godocdown. When the documentation for the
readme for github should be updated because the package or package's
documentation changes, run:
sh update_readme.sh
to update README.md. This commit is meant to be the first step in
addressing #3.