Jack Humbert 3e3c3e2b24 start glossary		8 жил өмнө
..
features	391eae97e4 testing out new home	8 жил өмнө
gitbook	704794bae3 subtree docs	8 жил өмнө
README.md	b75ad215c8 use default base names	8 жил өмнө
_summary.md	3e3c3e2b24 start glossary	8 жил өмнө
adding_a_keyboard_to_qmk.md	7b3c9cc8de Create adding_a_keyboard_to_qmk.md	8 жил өмнө
adding_features_to_qmk.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
basic_how_keyboards_work.md	7e84b0e3b3 move old doc to docs	8 жил өмнө
basic_keycodes.md	d5244c6cf4 restructure keycode docs	8 жил өмнө
becoming_a_qmk_collaborator.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
build_environment_setup.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
build_guide.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
build_old.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
compatible_microcontrollers.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
config_options.md	40d82906cb adds config options md	8 жил өмнө
custom_quantum_functions.md	7da94ac51b Fixup the gitbook config	8 жил өмнө
cygwin_guide.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
differences_from_tmk.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
dynamic_macros.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
eclipse.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
embedding.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
faq.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
faq_build.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
faq_keymap.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
fuse.txt	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
git_subtree.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
glossary.md	3e3c3e2b24 start glossary	8 жил өмнө
hand_wire.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
hhkb_alt_controller.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
how_to_github.md	9f643ba8bf clean-up github page	8 жил өмнө
isp_flashing_guide.md	c208a6d4e5 update docs for isp	8 жил өмнө
key_functions.md	621ae42a6c revert edit	8 жил өмнө
keycode.txt	d9f95c5da9 Docfix (#1377)	8 жил өмнө
keycodes.md	d5244c6cf4 restructure keycode docs	8 жил өмнө
keymap.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
keymap_config_h_example.h	7e84b0e3b3 move old doc to docs	8 жил өмнө
keymap_examples.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
keymap_makefile_example.mk	7e84b0e3b3 move old doc to docs	8 жил өмнө
keymap_old.md	7e84b0e3b3 move old doc to docs	8 жил өмнө
kiibohd.asciidoc	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
leader_key.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
license_clarification.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
license_clarification_details.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
macros.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
make_instructions.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
mbed_cortex_porting.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
memory_write_error,_use_debug_for_more_info.md	c208a6d4e5 update docs for isp	8 жил өмнө
modding_your_keyboard.md	ea7590c894 add new arguements, docs	8 жил өмнө
mouse_keys.md	ca01d94005 convert docs to lowercase and underscores	8 жил өмнө
other_projects.md	7e84b0e3b3 move old doc to docs	8 жил өмнө
pcb_guide.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
porting_your_keyboard_to_qmk.md	f32c68ee65 Update porting_your_keyboard_to_qmk.md	8 жил өмнө
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
power.txt	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
previously_asked_questions.asciidoc	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
qmk_overview.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
quantum_keycodes.md	910d32c07e Flesh out the quantum_keycodes documentation	8 жил өмнө
report_descriptor.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
space_cadet_shift.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
tap_dance.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
test_for_asciidoc.asciidoc	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
tmk_based_projects.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
tmk_own_projects.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
tmk_readme.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
understanding_qmk.md	7da94ac51b Fixup the gitbook config	8 жил өмнө
unicode_and_additional_language_support.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
unit_testing.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
usb_hid.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
usb_nkro.txt	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө
vagrant_guide.md	995c3141a6 convert docs to lowercase and underscores	8 жил өмнө

Quantum Mechanical Keyboard Firmware

What is QMK 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 {#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 {#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 {#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.