2019-07-18 06:41:17 +02:00
|
|
|
# KMK: Clackety Keyboards Powered by Python
|
|
|
|
|
|
|
|
|
|
KMK is a feature-rich and beginner-friendly firmware for computer keyboards
|
|
|
|
|
written and configured in
|
|
|
|
|
[CircuitPython](https://github.com/adafruit/circuitpython). **KMK is currently
|
2021-06-25 19:53:58 +02:00
|
|
|
in public beta, and transitioning to a new core, however should handle almost
|
|
|
|
|
all workflows without major issues**.
|
2019-07-18 06:41:17 +02:00
|
|
|
|
2019-07-25 06:04:15 +02:00
|
|
|
You can always find the latest releases on our CDN, in [compiled and
|
|
|
|
|
optimized](https://cdn.kmkfw.io/kmk-latest.zip) and [raw, hackable text
|
|
|
|
|
file](https://cdn.kmkfw.io/kmk-latest.unoptimized.zip) forms. These follow the
|
|
|
|
|
`master` branch here on GitHub.
|
|
|
|
|
|
2019-07-18 06:41:17 +02:00
|
|
|
> If you need support with KMK or just want to say hi, find us in
|
2020-03-30 06:48:23 +02:00
|
|
|
> [#kmkfw:klar.sh on Matrix](https://matrix.to/#/#kmkfw:klar.sh). This channel
|
|
|
|
|
> is bridged to Discord
|
|
|
|
|
> [here](https://discordapp.com/widget?id=493256121075761173&theme=dark) for
|
|
|
|
|
> convenience.
|
2019-07-25 05:54:06 +02:00
|
|
|
>
|
|
|
|
|
> If you ask for help on chat or open a bug report, if possible please give us
|
|
|
|
|
> your commit SHA, found by running `from kmk.consts import KMK_RELEASE;
|
|
|
|
|
> print(KMK_RELEASE)` in the REPL on your controller.
|
2019-07-18 06:41:17 +02:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
2019-07-25 06:16:26 +02:00
|
|
|
- Fully configured through a single, easy to understand Python file that lives
|
|
|
|
|
on a "flash-drive"-esque space on your microcontroller - edit on the go
|
|
|
|
|
without DFU or other devtooling available!
|
|
|
|
|
- Single-piece or [two-piece split
|
|
|
|
|
keyboards](https://github.com/KMKfw/kmk_firmware/blob/master/docs/split_keyboards.md)
|
|
|
|
|
are supported
|
|
|
|
|
- [Chainable
|
|
|
|
|
keys](https://github.com/KMKfw/kmk_firmware/blob/master/docs/keys.md) such as
|
|
|
|
|
`KC.LWIN(KC.L)` to lock the screen on a Windows PC
|
|
|
|
|
- [Built-in unicode macros, including
|
|
|
|
|
emojis](https://github.com/KMKfw/kmk_firmware/blob/master/docs/sequences.md)
|
|
|
|
|
- [RGB underglow](https://github.com/KMKfw/kmk_firmware/blob/master/docs/rgb.md)
|
|
|
|
|
and [LED
|
|
|
|
|
backlights](https://github.com/KMKfw/kmk_firmware/blob/master/docs/led.md)
|
|
|
|
|
- One key can turn into many more based on [how many times you tap
|
|
|
|
|
it](https://github.com/KMKfw/kmk_firmware/blob/master/docs/tapdance.md)
|
2020-10-21 21:19:42 +02:00
|
|
|
- Bluetooth HID and split keyboards. No more wires.
|
2019-07-18 06:41:17 +02:00
|
|
|
|
|
|
|
|
## Getting Started
|
2020-10-21 21:19:42 +02:00
|
|
|
Our getting started guide can be found [here](https://github.com/KMKfw/docs/Getting_Started.md)
|
2019-07-18 06:41:17 +02:00
|
|
|
|
|
|
|
|
## The KMK Team
|
|
|
|
|
|
|
|
|
|
KMK is primarily written and maintained by @klardotsh and @kdb424, but
|
|
|
|
|
contributions are welcome from all, whether it's in the form of code,
|
|
|
|
|
documentation, hardware designs, feature ideas, or anything else that comes to
|
|
|
|
|
mind. KMK's contributors and other helpers are listed alphabetically by username
|
|
|
|
|
below (we'll try to keep this up to date!):
|
|
|
|
|
|
|
|
|
|
- [Dan Halbert (@dhalbert)](https://github.com/dhalbert)
|
|
|
|
|
- [Elvis Pfützenreuter (@elvis-epx)](https://github.com/elvis-epx)
|
2018-10-06 14:58:07 +02:00
|
|
|
- [Kyle Brown (@kdb424)](https://github.com/kdb424)
|
2019-07-18 06:41:17 +02:00
|
|
|
- [Josh Klar (@klardotsh)](https://github.com/klardotsh)
|
|
|
|
|
- [Limor Fried (@ladyada)](https://github.com/ladyada)
|
|
|
|
|
- [Ryan Karpinski (@rk463345)](https://github.com/rk463345)
|
2018-11-25 11:53:46 +01:00
|
|
|
- [@siddacious](https://github.com/siddacious)
|
2018-10-25 23:57:02 +02:00
|
|
|
- [Scott Shawcroft (@tannewt)](https://github.com/tannewt)
|
|
|
|
|
|
2019-07-18 07:38:40 +02:00
|
|
|
> While Adafruit employees and affiliates are included in the above list and
|
2019-07-18 06:41:17 +02:00
|
|
|
> their help has been crucial to KMK's success, KMK is not an official Adafruit
|
|
|
|
|
> project, and the Core team is not compensated by Adafruit for its development.
|
2018-08-30 22:31:02 +02:00
|
|
|
|
2019-07-25 07:56:10 +02:00
|
|
|
## Code Style
|
|
|
|
|
|
|
|
|
|
KMK uses [Black](https://github.com/psf/black) with a Python 3.6 target and,
|
|
|
|
|
[(controversially?)](https://github.com/psf/black/issues/594) single quotes.
|
|
|
|
|
Further code styling is enforced with isort and flake8 with several plugins.
|
|
|
|
|
`make fix-isort fix-formatting` before a commit is a good idea, and CI will fail
|
|
|
|
|
if inbound code does not adhere to these formatting rules. Some exceptions are
|
|
|
|
|
found in `setup.cfg` loosening the rules in isolated cases, notably
|
|
|
|
|
`user_keymaps` (which is *also* not subject to Black formatting for reasons
|
|
|
|
|
documented in `pyproject.toml`).
|
|
|
|
|
|
2018-08-30 22:31:02 +02:00
|
|
|
## License, Copyright, and Legal
|
|
|
|
|
|
2019-07-18 06:41:17 +02:00
|
|
|
All software in this repository is licensed under the [GNU Public License,
|
|
|
|
|
verison 3](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)).
|
|
|
|
|
All documentation and hardware designs are licensed under the [Creative Commons
|
|
|
|
|
Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
|
|
|
|
|
license. Contributions to this repository must use these licenses unless
|
|
|
|
|
otherwise agreed to by the Core team.
|
