search

keyboardio / Kaleidoscope

Firmware for Keyboardio keyboards and other keyboards with AVR or ARM MCUs.
http://keyboard.io
GNU General Public License v3.0
757 stars 259 forks source link

Document the hardware plugins #628

Open algernon opened 5 years ago

algernon commented 5 years ago

Our hardware plugins lack documentation. At the minimum, they should contain a brief description of the hardware, links to the device's homepage, vendor or any relevant page. We should also document the limitations of each plugin (eg, the EZ-ErgoDox plugin doesn't support LEDs yet, neither the EZ Shine, nor the EZ Glow; Planck only supports AVR variants and no sound, etc).

madham32 commented 5 years ago

Hi @algernon! I was intending to apply taking up this project as part of Season of Docs. Could you please get me up to date with what you may expect of whoever is assigned this task. Many thanks