search

jpconstantineau / BlueMicro_HID_Arduino_Library

Universal BLE/USB HID Library
Other
20 stars 0 forks source link

Create documentation #1

Open jeff-j-chen opened 2 years ago

jeff-j-chen commented 2 years ago

Hello, I greatly appreciate your project as it is allowing me to work with my Adafruit Feather perfectly. However, I think myself and other users would definitely appreciate documentation on the given functions. I tried my best to understand it from the given examples, but a readthedocs page with explanations for what KeyboardReport, Keypress, and all the other functions do and how to use them would be hihgly useful.

jpconstantineau commented 2 years ago

I agree that some docs would be very useful. It's been started but sure need lots more work. I would appreciate any help on that.

The functions maps relatively well with the ones in the Bluefruit library here as well as the TinyUSB library here. I don't know if they do have documentation somewhere for these but they would be a good starting point.

One of the key difference is that queues are being used between when the "send" functions are called and when the "processqueues" is used.

I am currently refactoring my keyboard firmware code to use this library and will be able to put some more updates as I get the work progressing.

I would welcome any addition to the documentation or library. Since this is an Arduino Library and that the whole repo gets included as part of the library, I would want to keep the documentation pretty lean (as in just using simple md files) as opposed to a bigger framework included in the repo to be published somewhere else. I would welcome any suggestions how to proceed to keep it lean.

jeff-j-chen commented 2 years ago

You could create a simple readthedocs page and make a link on the README, I find myself referencing them all the time, especially for Python libraries like pyautogui.

I don't know how much help I can be for writing documentation given that I'm having trouble understanding what the functions do and how to use them, and my knowledge of C++ is very limited. As I familiarize myself with this library I'll see if I can contribute.