History

Snipeye cfd118d158 Added Dichotemy Keyboard, updated docs for Pointing Device (#1817 ) * Added Dichotemy Keyboard, updated docs for Pointing Device * Updated readme * Updated mouse report pointer in pointing_device.c		2017-10-10 07:07:59 -10:00
..
gitbook/images	…
README.md	…
_summary.md	Added Dichotemy Keyboard, updated docs for Pointing Device (#1817 )	2017-10-10 07:07:59 -10:00
adding_a_keyboard_to_qmk.md	Minor typo	2017-10-05 07:22:25 -10:00
adding_features_to_qmk.md	…
becoming_a_qmk_collaborator.md	…
compatible_microcontrollers.md	…
config_options.md	…
custom_quantum_functions.md	…
documentation_best_practices.md	…
dynamic_macros.md	…
eclipse.md	…
faq.md	…
faq_build.md	…
faq_debug.md	Fixed typo in docs. (#1818 )	2017-10-06 20:15:55 -07:00
faq_general.md	…
faq_keymap.md	…
feature_audio.md	…
feature_auto_shift.md	Fixed a few typos and spelling errors in auto shift feature document	2017-09-18 17:08:18 -04:00
feature_backlight.md	…
feature_bluetooth.md	…
feature_bootmagic.md	Edited a minor typo in feature_bootmagic.md.	2017-10-05 06:17:34 -10:00
feature_common_shortcuts.md	Fixed typo of "multually" to "mutually"	2017-09-25 13:08:06 -04:00
feature_layouts.md	…
feature_leader_key.md	…
feature_pointing_device.md	Generic Pointing Device (#1767 )	2017-10-06 07:13:08 -10:00
feature_ps2_mouse.md	…
feature_rgblight.md	Fix HSV Color Wheel image on RGB Light page (#1773 )	2017-09-29 16:19:15 -07:00
feature_terminal.md	Updates send_string functionality, adds terminal feature (#1657 )	2017-09-12 00:43:10 -04:00
feature_thermal_printer.md	…
features.md	Generic Pointing Device (#1767 )	2017-10-06 07:13:08 -10:00
fuse.txt	…
getting_started_build_tools.md	Add shell.nix for NixOS users	2017-09-25 13:14:20 -04:00
getting_started_github.md	…
getting_started_instroduction.md	…
getting_started_make_guide.md	…
getting_started_vagrant.md	…
glossary.md	…
hand_wire.md	…
how_keyboards_work.md	…
isp_flashing_guide.md	…
key_lock.md	…
keycode.txt	…
keycodes.md	updated keycodes media descriptions	2017-09-25 13:07:46 -04:00
keycodes_basic.md	platform descriptions to match master keycodes.md documentation	2017-09-25 13:07:46 -04:00
keycodes_us_ansi_shifted.md	…
keymap.md	…
macros.md	Updates send_string functionality, adds terminal feature (#1657 )	2017-09-12 00:43:10 -04:00
mouse_keys.md	…
porting_your_keyboard_to_qmk.md	…
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md	…
power.txt	…
quantum_keycodes.md	…
redirects.json	…
space_cadet_shift.md	…
stenography.md	…
tap_dance.md	Reference to rules.mk in tap dance docs added	2017-10-03 09:04:31 -10:00
understanding_qmk.md	Added Auto Shift, tap key = normal, hold key = shifted state.	2017-09-18 17:08:18 -04:00
unicode.md	…
unit_testing.md	…
usb_nkro.txt	…

README.md

Quantum Mechanical Keyboard Firmware

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Flasher, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the tmk_keyboard with some useful features for Atmel AVR controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line. It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.

How to get it

If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is fork the repo through Github, and clone your repo locally to make your changes, push them, then open a Pull Request from your fork.

Otherwise, you can either download it directly (zip, tar), or clone it via git (git@github.com:qmk/qmk_firmware.git), or https (https://github.com/qmk/qmk_firmware.git).

How to compile

Before you are able to compile, you'll need to install an environment for AVR or/and ARM development. Once that is complete, you'll use the make command to build a keyboard and keymap with the following notation:

make planck-rev4-default

This would build the rev4 revision of the planck with the default keymap. Not all keyboards have revisions (also called subprojects), in which case, it can be omitted:

make preonic-default

How to customize

QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your keymap, and changing the keycodes.