README: convert to markdown #17
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
|
Looks good to me. Thanks! |
Qbicz
reviewed
Jun 9, 2019
There was a problem hiding this comment.
Thank you. Looking at the preview, I have 2 observations:
- the text is now rather lengthy in comparison to original, which is more compressed. I feel the markdown version is overwhelming, what about having some table of contents in the beginning?
- Title of library is broken down into 2 lines, with "X" from OS X in second line. What about using ## heading which would results in smaller letters?
Youw
reviewed
Jun 10, 2019
Youw
approved these changes
Jun 10, 2019
Qbicz
pushed a commit
that referenced
this pull request
Jun 14, 2019
The 'make' build on Linux/MacOS generates an error since README.txt was renamed to README.md. See #17 .
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.
Ref #11
This is a plain conversion without any changes to the text.
Preview: https://github.com/z3ntu/hidapi/blob/readme_md/README.md