qmk_firmware/docs
2018-08-11 23:02:06 -07:00
..
gitbook/images
_sidebar.md Dedupe shifted keycodes listing 2018-08-11 14:29:53 -07:00
_summary.md Dedupe shifted keycodes listing 2018-08-11 14:29:53 -07:00
.nojekyll
becoming_a_qmk_collaborator.md
CNAME
compatible_microcontrollers.md
config_options.md Document FIRMWARE_FORMAT (#3631) 2018-08-11 23:02:06 -07:00
contributing.md
custom_quantum_functions.md
documentation_best_practices.md
documentation_templates.md
eclipse.md
faq_build.md
faq_debug.md
faq_general.md
faq_keymap.md Update FAQ section on power keys 2018-08-11 14:30:53 -07:00
faq.md
feature_advanced_keycodes.md Dedupe shifted keycodes listing 2018-08-11 14:29:53 -07:00
feature_audio.md
feature_auto_shift.md
feature_backlight.md Docs: Add Usage section to backlight docs (#3537) 2018-07-31 17:40:09 -07:00
feature_bluetooth.md
feature_bootmagic.md
feature_command.md Docs: Fix Command docs escaping (#3523) 2018-07-29 21:08:59 -07:00
feature_dynamic_macros.md
feature_grave_esc.md Docs: Format Grave Escape documentation (#3536) 2018-07-31 17:40:55 -07:00
feature_hd44780.md
feature_key_lock.md Docs: Format Key Lock documentation (#3538) 2018-07-31 18:07:50 -07:00
feature_layouts.md
feature_leader_key.md
feature_macros.md
feature_mouse_keys.md
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgb_matrix.md RGB Driver Documentation Update (#3601) 2018-08-09 17:41:48 -07:00
feature_rgblight.md Improve RGB lighting documentation (#3580) 2018-08-07 09:07:19 -07:00
feature_space_cadet_shift_enter.md Docs: Format Space Cadet documentation (#3540) 2018-08-01 08:43:54 -07:00
feature_space_cadet_shift.md Docs: Format Space Cadet documentation (#3540) 2018-08-01 08:43:54 -07:00
feature_stenography.md
feature_swap_hands.md fix swap_hands keycodes in documentation (#3588) 2018-08-07 14:20:29 -07:00
feature_tap_dance.md Docs: Fix some minor errors in tap dance example (#3530) 2018-07-31 17:50:02 -07:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md
features.md Dedupe shifted keycodes listing 2018-08-11 14:29:53 -07:00
flashing.md
fuse.txt
getting_started_build_tools.md
getting_started_getting_help.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
hand_wire.md
hardware_avr.md
hardware_drivers.md RGB Driver Documentation Update (#3601) 2018-08-09 17:41:48 -07:00
hardware_keyboard_guidelines.md
hardware.md
how_keyboards_work.md
index.html
internals_defines.md
internals_input_callback_reg.md
internals_midi_device_setup_process.md
internals_midi_device.md
internals_midi_util.md
internals_send_functions.md
internals_sysex_tools.md
isp_flashing_guide.md Update ISP flashing guide with pre-compiled binary (#3217) 2018-08-02 23:07:33 -04:00
keycode.txt
keycodes_basic.md More improvements to keycode docs (#3567) 2018-08-04 09:09:22 -07:00
keycodes_us_ansi_shifted.md Update Shifted keycodes docs (#3575) 2018-08-05 08:55:53 -07:00
keycodes.md Dedupe shifted keycodes listing 2018-08-11 14:29:53 -07:00
keymap.md
newbs_building_firmware.md
newbs_flashing.md
newbs_getting_started.md
newbs_learn_more_resources.md
newbs_testing_debugging.md
newbs.md
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
power.txt
qmk.css
quantum_keycodes.md
README.md
redirects.json Docs: Format Space Cadet documentation (#3540) 2018-08-01 08:43:54 -07:00
reference_glossary.md Docs: Format Space Cadet documentation (#3540) 2018-08-01 08:43:54 -07:00
sidebar.css
sw.js
understanding_qmk.md
unit_testing.md
usb_nkro.txt

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

What is QMK Firmware?

QMK (Quantum Mechanical Keyboard) is an open source community that maintains QMK Firmware, QMK Toolbox, 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.