Improve README #65
Open
Improve README #65
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
Signed-off-by: Abhineet Tamrakar <abhineet97@gmail.com>
Signed-off-by: Abhineet Tamrakar <abhineet97@gmail.com>
Signed-off-by: Abhineet Tamrakar <abhineet97@gmail.com>
Patamap
added
Doc
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.
Hello.
As discussed here, I believe that we can vastly simplify FLINT's README. Through this PR, I've tried to propose some improvements. A summary of the changes is as follows:
I've based most of these changes by following Google's excellent documentation style guide. I would strongly suggest that moja global should adopt a documentation style guide for use in all present and future documentations.
Please let me know if there's something that you would like me to change in this PR. Thanks!