qmk_firmware/docs
discursivemoth b7d43ee253 correct tilde to grave
..
gitbook/images subtree docs
README.md Update a bunch of docs
_summary.md Added initial key lock documentation.
adding_a_keyboard_to_qmk.md Create adding_a_keyboard_to_qmk.md
adding_features_to_qmk.md Update a bunch of docs
basic_how_keyboards_work.md update basic_how_keyboards_work
basic_keycodes.md add short name for locking mods to docs.
becoming_a_qmk_collaborator.md convert docs to lowercase and underscores
build_environment_setup.md Change installation of avr-libc to avr-gcc, now that avr-libc is integrated into the avr-gcc build
compatible_microcontrollers.md convert docs to lowercase and underscores
config_options.md adds config options md
custom_quantum_functions.md Fix minor formatting issue.
documentation_best_practices.md Add terminal examples to doc best practices
dynamic_macros.md convert docs to lowercase and underscores
eclipse.md Update a bunch of docs
faq.md Rearrange the faq a bit
faq_build.md Update a bunch of docs
faq_keymap.md fix code block formatting
features.md Rename docs/features/README.md to docs/features.md
fuse.txt convert docs to lowercase and underscores
glossary.md Invites contributions
hand_wire.md update hand_wire
how_to_github.md clean-up github page
isp_flashing_guide.md update docs for isp
key_functions.md Update a bunch of docs
key_lock.md Added support for locking One Shot modifiers.
keycode.txt Docfix ()
keycodes.md restructure keycode docs
keymap.md convert docs to lowercase and underscores
leader_key.md convert docs to lowercase and underscores
macros.md Merge branch 'master' into docs
make_instructions.md Added initial key lock documentation.
modding_your_keyboard.md adds option for alt pitch standards
mouse_keys.md Merge branch 'master' into docs
porting_your_keyboard_to_qmk.md fix section in porting guide that refered to Makefile instead of rules.mk
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md convert docs to lowercase and underscores
power.txt convert docs to lowercase and underscores
qmk_overview.md convert docs to lowercase and underscores
quantum_keycodes.md correct tilde to grave
space_cadet_shift.md convert docs to lowercase and underscores
stenography.md Fix typo in docs.
tap_dance.md Update a bunch of docs
understanding_qmk.md Update a bunch of docs
unicode.md Add missing files to _summary.md
unit_testing.md convert docs to lowercase and underscores
usb_nkro.txt convert docs to lowercase and underscores
vagrant_guide.md Update the vagrant guide

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.