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.

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

Update README.txt/AUTHORS.txt #11

Closed
Youw opened this issue Jun 6, 2019 · 6 comments
Closed

Update README.txt/AUTHORS.txt #11

Youw opened this issue Jun 6, 2019 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@Youw
Copy link
Member

Youw commented Jun 6, 2019

  • add notice about moving under @libusb/hidapi;
  • update links if there are any;
  • consider Markdown?
@Youw Youw added the documentation Improvements or additions to documentation label Jun 6, 2019
@todbot
Copy link
Contributor

todbot commented Jun 6, 2019

+1 on Markdown

@z3ntu
Copy link
Collaborator

z3ntu commented Jun 10, 2019

Notes from #17 that should be fixed as a follow-up:

  • 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?

@Qbicz
Copy link
Member

Qbicz commented Jul 23, 2019

Fixed by #19

@Qbicz Qbicz closed this as completed Jul 23, 2019
@Youw
Copy link
Member Author

Youw commented Jul 23, 2019

AUTHORS.txt hasn't been updated yet, aren't we going to?

@Qbicz
Copy link
Member

Qbicz commented Aug 2, 2019

@Youw if you have idea how AUTHORS should now look like, please go ahead with PR ;)

@Youw
Copy link
Member Author

Youw commented Aug 2, 2019

I'll think of something when I'm back from a family trip. (Somewhere next week.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants