sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #7 from klardotsh/cleanup

Browse Source 
Readme cleanup
This commit is contained in:
Josh Klar 2018-09-03 15:34:51 -07:00 committed by GitHub
commit 30e4352935
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -18,14 +18,13 @@ This project is currently written and maintained by @klardotsh and @kdb424.
### Officially Supported ### Officially Supported
- [Adafruit Feather nRF52 BLE Controller](https://www.adafruit.com/product/3406) - [Adafruit Feather nRF52 BLE Controller](https://www.adafruit.com/product/3406)
- [Teensy 3.2 Controller](https://www.adafruit.com/product/2756)
### Support Planned/WIP ### Support Planned/WIP
- [Planck rev6 Keyboard](https://olkb.com/planck) - [Planck rev6 Keyboard](https://olkb.com/planck)
- [Proton C - [Proton C
Controller?](https://www.reddit.com/r/MechanicalKeyboards/comments/87cw36/render_of_the_qmk_proton_c_qmkpowered_pro_micro/) Controller?](https://www.reddit.com/r/MechanicalKeyboards/comments/87cw36/render_of_the_qmk_proton_c_qmkpowered_pro_micro/)
* Does not exist yet, basically a Planck6 in a Pro Micro pin-compat controller chip * Does not exist yet, the controller from a Planck rev6 in a Pro Micro pin-compat controller chip
- [Teensy 3.2 Controller](https://www.adafruit.com/product/2756)
* Has at least MicroPython, possibly CircuitPython as well
## Unsupported Devices ## Unsupported Devices
@ -33,12 +32,11 @@ This project is currently written and maintained by @klardotsh and @kdb424.
If you don't see it in "Supported Devices", it won't work out of the box, it's If you don't see it in "Supported Devices", it won't work out of the box, it's
basically that simple. Pull requests are welcome and encouraged to add support basically that simple. Pull requests are welcome and encouraged to add support
for new keyboards. The base requirements for device support are a port of for new keyboards. The base requirements for device support are a port of
CircuitPython (technically base MicroPython could still work), at least CircuitPython or MicroPython, at least 256KB of flash storage, and USB and/or
256KB of flash storage, and USB and/or Bluetooth LE interfaces. DFU Bluetooth LE interfaces.
bootloaders are very strongly encouraged, but not required.
Devices require at least 256KB of flash to run KMK, and that's already pretty Devices require at least 256KB of flash to run KMK, and that's already pretty
tight. In general this means that no or almost no Arduinos are or will ever be tight. This means that no AVR based microcontrollers are, or will ever be
supported. This extends to Arduino-compatibles, including the Pro Micro. If you supported. This extends to Arduino-compatibles, including the Pro Micro. If you
want to run custom firmware on your Pro Micro-equipped keyboard, or for that want to run custom firmware on your Pro Micro-equipped keyboard, or for that
matter anything running the ATmega32U4 (Let's Split, Plancks before rev6, matter anything running the ATmega32U4 (Let's Split, Plancks before rev6,