Update read me #165
Open
Update read me #165
Conversation
This file contains hidden or 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
Contributor
|
There are some good changes in here, but the man page is currently generated from README.rst. Is there a conversion tool (e.g. https://github.com/rtomayko/ronn) that will give us equivalent or similar functionality? If so, could you update the Makefile here and update your README.md with any necessary annotations? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description of changes:
This PR changes multiple text files to conform with Github conventions and best practices:
Replaces
README.rstfor a markdown versionREADME.md. This makes text compatible with all the formatting used in github.Removes the
.txtextension from LICENSE. This change make the license traceable by Github and other tools that analises license compliance like FOSSA https://app.fossa.com/.Replaces .txt
for.md` on NOTICE. This change makes the notice compatible with the new Github mobile app.Fixes markdown format issues on all markdown files like links and headers levels.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.