drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

[Keyboard] Modernize KMAC (#6131)

Browse source 
* [Keyboard] Modernize the KMAC implementation

This brings the matrix implementation more in line with the current
default matrix code.
It also simplifies the implementation quite a bit.

* [Keyboard] Add layout support to KMAC
This commit is contained in:
Mathias Andersson 2019-06-26 09:32:03 +02:00 • committed by Drashna Jaelre
parent 8fd3f42281
commit 3483c51f62
19 changed files with 573 additions and 624 deletions
Download patch file Download diff file Expand all files Collapse all files

43
keyboards/kmac/readme.md
View file

@ -1,44 +1,21 @@
# KMAC keyboard firmware
# KMAC
A Korean custom keyboard designed by Byungho Kim and the KBDMania community.
## Supported models
Keyboard Maintainer: [Mathias Andersson](https://github.com/wraul)
Hardware Supported: KMAC & KMAC 2
Hardware Availability: http://www.kbdmania.net/xe/news/5232321
All the tenkeyless models should be supported.
Make example for this keyboard (after setting up your build environment):
make kmac:default
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
## Bootloader
The PCB is hardwired to run the bootloader if the key at the `Caps Lock` position is held down when connecting the keyboard.
It is also possible to use Boot Magic and Command to access the bootloader.
## Quantum MK Firmware
For the full Quantum feature list, see the [documentation](https://docs.qmk.fm).
## Building
## PCB versions
The KMAC are available with two different PCB layouts, a winkey version and a winkeyless version. A default keymap are provided for each versions of the PCB.
Depending on which PCB and keymap you would like to use, you will have to compile the firmware slightly differently. All of the commands should be run in the [qmk root](https://github.com/qmk/qmk_firmware/) folder.
### Winkey keymap
The [default keymap](keymaps/default) are designed for the winkey version of the PCB.
### Winkeyless Keymap
A [keymap](keymaps/winkeyless) for the winkeyless version of the PCB are also provided.
### Custom keymaps
To define your own keymap, copy one of the [existing keymap](keymaps) folders and give it the name of your keymap. Then check the [keymap documentation](https://docs.qmk.fm/faq_keymap.html) for details on how to modify the keymap.
To make it easy to define keymaps for the different versions of the PCB two macros are provided.
| PCB | Macro |
| -------------- | -------------- |
| Winkey PCB | `LAYOUT()` |
| Winkeyless PCB | `LAYOUT_WKL()` |
To build the firmware with a custom keymap, run `make <keymap name>`