Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: Add table of contents & fix markdown #19

Merged
merged 2 commits into from
Jun 17, 2019
Merged

README: Add table of contents & fix markdown #19

merged 2 commits into from
Jun 17, 2019

Conversation

Qbicz
Copy link
Member

@Qbicz Qbicz commented Jun 13, 2019 •
edited
Loading

  • Markdown fixes.
  • Table of contents

@Qbicz
README: Fix markdown description
ff9d9b4 
No changes to meaning, just markdown fixes.

Signed-off-by: Filip Kubicz <filip.kubicz@nordicsemi.no>
@Qbicz Qbicz force-pushed the readme-markdown-fixes branch 4 times, most recently from e9897ad to 8525de2 Compare June 13, 2019 09:06
@Qbicz Qbicz changed the title README: Fix markdown description README: Add table of contents & fix markdown Jun 13, 2019
@Qbicz Qbicz requested review from todbot and Youw June 13, 2019 09:08
@Qbicz Qbicz added the documentation Improvements or additions to documentation label Jun 13, 2019
@Qbicz
Copy link
Member Author

Qbicz commented Jun 13, 2019

See #11

@Qbicz
Copy link
Member Author

Qbicz commented Jun 13, 2019

Output rendered under https://github.com/Qbicz/hidapi-1/tree/readme-markdown-fixes

Youw
Youw reviewed Jun 13, 2019
View reviewed changes
Copy link
Member

@Youw Youw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest replacing all "Mac OS X" with "macOS" - Apple renamed it in 2016

README.md Outdated Show resolved Hide resolved
@Qbicz
Copy link
Member Author

Qbicz commented Jun 13, 2019

@Youw all changes applied.

Youw
Youw approved these changes Jun 13, 2019
View reviewed changes
Copy link
Member

@Youw Youw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

z3ntu
z3ntu reviewed Jun 13, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
z3ntu
z3ntu reviewed Jun 13, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
z3ntu
z3ntu reviewed Jun 13, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
z3ntu
z3ntu reviewed Jun 13, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
z3ntu
z3ntu reviewed Jun 13, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
@z3ntu
Copy link
Collaborator

z3ntu commented Jun 13, 2019 •
edited
Loading

HIDAPI may be used by one of three licenses as outlined in LICENSE.txt.

I'd make the LICENSE.txt into a link to the file

HIDAPI can be downloaded from github

Make it GitHub

These platform Makefiles are located in linux/ libusb/ mac/ and windows/ and are called Makefile-manual.

More codeblocks there

On Windows, if you want to build the test GUI, you will need to get the hidapi-externals.zip package from the download site.

Codeblock around the zip; does someone have this file / can someone make this file?

On Unix-like systems such as Linux, FreeBSD, Mac, and even Windows, using Mingw or Cygwin

macOS and MinGW

To build the HIDAPI DLL on Windows using Visual Studio, build the .sln file in the windows/ directory.

Codeblocks around the directory names (and the line below)

To build HIDAPI using MinGW using the Manual Makefiles, see the section "Building the manual way on Unix platforms" above.

Link the section there

Build Libusb. From the libusb source directory, run:

Make libusb lower-case there

Signal 11 Software
2010-04-11

Can we remove that footer? I don't even know what it should represent exactly? The dates the readme was modified?

@Qbicz Qbicz force-pushed the readme-markdown-fixes branch 2 times, most recently from db91a69 to 0f55e33 Compare June 17, 2019 08:07
@Qbicz
Copy link
Member Author

Qbicz commented Jun 17, 2019

@z3ntu thanks for nitpicking. I fixed it all (I hope!). Now we should have a much better description, thanks!

@z3ntu
Copy link
Collaborator

z3ntu commented Jun 17, 2019

The paragraph

If you have your own simple test programs which communicate with standard hardware development boards (such as those from Microchip, TI, Atmel, FreeScale and others), please consider sending me something like the above for inclusion into the HIDAPI source. This will help others who have the same hardware as you do.

could probably be removed as well.

Otherwise LGTM!

@Qbicz
README: added table of contents
87cec97 
The README is long. Added table of contents in order to save reader from
being overwhelmed.

Updated README where appropriate.

Signed-off-by: Filip Kubicz <filip.kubicz@nordicsemi.no>
@Qbicz
Copy link
Member Author

Qbicz commented Jun 17, 2019

@z3ntu agreed, removed.

@Qbicz Qbicz merged commit e5ce14a into libusb:master Jun 17, 2019
@Qbicz Qbicz deleted the readme-markdown-fixes branch June 17, 2019 10:09
@Qbicz Qbicz mentioned this pull request Jul 23, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@z3ntu z3ntu z3ntu left review comments

@todbot todbot todbot approved these changes

@Youw Youw Youw approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Qbicz @z3ntu @todbot @Youw