kmk_firmware/docs/en/kmkpython_vs_circuitpython.md
Phong Le 2ccad46e26
update modtap to holdtap (#718)
* update modtap to holdtap

* Update links

* Revert "Update links"

This reverts commit 8d0cda7c5a.

* updated docs links

update links in docs

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* rename modtap.md to holdtap.md

* Update Getting_Started.md

* Update main.py

* Update modtap.py

* Update modtap.py and add notice

* Update docs/en/porting_to_kmk.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/handwiring.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/contributing.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/contributing.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/ble_hid.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/kmkpython_vs_circuitpython.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Rename modtap.md to holdtap.md

* fixup

---------

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
2023-03-03 09:32:41 +00:00

1.2 KiB

THIS IS OUT OF DATE. DO NOT USE. ONLY FOR REFERENCE

Firmware of choice

KMKPython

KMKPython is a fork of CircuitPython, but with libraries for most extensions built in. This saves you from having to get them all and keep them updated yourself. There may be other features added in the future that are exclusive to KMKPython. For the nice!nano, this is highly recommended, and used in place of CircuitPython. Notable differences include

  • Built in libraries for Bluetooth, RGB, and more
  • Saves space as builds are optimized for keyboards
  • Microcontrollers like the nice!nano will be able to access all features out of the box.

CircuitPython

CircuitPython can be installed by following this guide using the guide for installing circuit python. It's recommended to run the latest stable version that is at least 5.0 or higher. Beta versions may work, but expect limited support.

Notable differences include

  • Supports more devices
  • Less built in libraries. If using RGB, Bluetooth, and more, you will have to add these libraries yourself
  • Some devices such as the nice!nano don't have much free space, so not all features can be installed at the same time