diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-04-04 19:32:33 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-04-04 19:32:33 -0400 |
| commit | 46179fbb7b3adf9c3ce8469718b6c8b8b337506d (patch) | |
| tree | a8feb10ae70251ff08a5df80475f5ca3ead2a65b /Home.md | |
| parent | c0a895340515342dd66744f40f314345150578c8 (diff) | |
| download | qmk_firmware-46179fbb7b3adf9c3ce8469718b6c8b8b337506d.tar.gz qmk_firmware-46179fbb7b3adf9c3ce8469718b6c8b8b337506d.zip | |
split off tmk differences into own page
Diffstat (limited to 'Home.md')
| -rw-r--r-- | Home.md | 11 |
1 files changed, 1 insertions, 10 deletions
@@ -1,15 +1,6 @@ # Quantum Mechanical Keyboard Firmware -You have found the QMK Firmware documentation site. This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB. - -Understanding the essential changes made on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) should help you understand the QMK Firmware. - -| Firmware |TMK |QMK | -|------------------------------|-----------------------|-------------------------| -| Maintainer |hasu (@tmk) |Jack Humbert et al. | -| Build path customization | `TMK_DIR = ...` | `include .../Makefile` | -| `keymaps` array data | 3D array of `uint8_t` holding **keycode** | 3D array of `uint16_t` holding **keycode** | -| `fn_actions` array data | 1D array of `uint16_t` holding **action code** | 1D array of `uint16_t` holding **action code** | +You have found the QMK Firmware documentation site. This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) ([view differences](Differences-from-TMK)) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB. # Getting started |