qmk-firmware/docs
Balz Guenat 858c09f370 add example keymap 2017-11-16 09:39:00 -05:00
..
gitbook/images
README.md
_summary.md Move keycodes to their own section 2017-11-10 17:58:32 -05:00
becoming_a_qmk_collaborator.md
compatible_microcontrollers.md
config_options.md
contributing.md update contributing guidelines 2017-11-01 21:42:05 -04:00
custom_quantum_functions.md
documentation_best_practices.md
documentation_templates.md
eclipse.md
faq.md
faq_build.md
faq_debug.md Document the Teensy hardware reset problem 2017-11-12 11:51:12 -05:00
faq_general.md Improvements to documentation (#1919) 2017-11-01 11:21:54 -04:00
faq_keymap.md
feature_advanced_keycodes.md 333fred layout update (#1971) 2017-11-06 12:09:01 -05:00
feature_audio.md
feature_auto_shift.md Correct the rules.mk documentation for auto shift. 2017-11-06 12:03:36 -05:00
feature_backlight.md
feature_bluetooth.md
feature_bootmagic.md
feature_dynamic_macros.md
feature_key_lock.md
feature_layouts.md
feature_leader_key.md
feature_macros.md add example keymap 2017-11-16 09:39:00 -05:00
feature_mouse_keys.md
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgblight.md
feature_space_cadet.md
feature_stenography.md
feature_tap_dance.md
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md Add "KC_MAKE" to userspace example 2017-11-14 11:02:00 -05:00
features.md
flashing.md
fuse.txt
getting_started_build_tools.md Improvements to documentation (#1919) 2017-11-01 11:21:54 -04:00
getting_started_github.md Update getting_started_github.md 2017-11-01 14:10:28 -04:00
getting_started_introduction.md update some docs 2017-11-09 16:19:13 -05:00
getting_started_make_guide.md
getting_started_vagrant.md update some docs 2017-11-09 16:19:13 -05:00
glossary.md
hand_wire.md Update hand_wire.md 2017-11-13 18:48:55 -05:00
hardware.md
hardware_avr.md
hardware_drivers.md
hardware_keyboard_guidelines.md use real greater than and less than chars 2017-11-02 16:27:17 -07:00
how_keyboards_work.md
isp_flashing_guide.md
keycode.txt
keycodes.md Clarify `KC_PWR` vs `KC_POWER`. Fixes #1994. 2017-11-10 17:58:32 -05:00
keycodes_basic.md
keycodes_us_ansi_shifted.md
keymap.md Fixed some grammar and typos on the docs (#1989) 2017-11-09 16:18:31 -05:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
power.txt
quantum_keycodes.md
redirects.json
understanding_qmk.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 or folders), 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.