qmk_firmware/docs
Drashna Jaelre 7b51f050d7 Fix typo in make example
It has `:all" when it clearly is referencing the command without `:all`.
..
gitbook/images RGB improvements ()
README.md Make arguments redo, subproject elimination ()
_summary.md Flesh out the grave escape overrides
becoming_a_qmk_collaborator.md convert docs to lowercase and underscores
compatible_microcontrollers.md convert docs to lowercase and underscores
config_options.md Update config_options.md
contributing.md Fix internal links in docs/ ()
custom_quantum_functions.md Fix internal links in docs/ ()
documentation_best_practices.md Doc updates from going through every file
documentation_templates.md Make arguments redo, subproject elimination ()
eclipse.md Update a bunch of docs
faq.md Overhaul the Getting Started section and add a FAQ section
faq_build.md Fix internal links in docs/ ()
faq_debug.md Document the Teensy hardware reset problem
faq_general.md Improvements to documentation ()
faq_keymap.md Flesh out the grave escape overrides
feature_advanced_keycodes.md update advanced_keycodes; oneshot = sticky/dead keys
feature_audio.md Doc updates from going through every file
feature_auto_shift.md Correct the rules.mk documentation for auto shift.
feature_backlight.md break up keymaps and quantum keycodes into files by feature
feature_bluetooth.md Doc updates from going through every file
feature_bootmagic.md Edited a minor typo in feature_bootmagic.md.
feature_dynamic_macros.md Restructure the hardware and feature docs to make things easier to find ()
feature_grave_esc.md Flesh out the grave escape overrides
feature_key_lock.md Fix internal links in docs/ ()
feature_layouts.md Update feature_layouts.md
feature_leader_key.md Doc updates from going through every file
feature_macros.md added SS_LSFT to featured macros
feature_mouse_keys.md Restructure the hardware and feature docs to make things easier to find ()
feature_pointing_device.md Generic Pointing Device ()
feature_ps2_mouse.md Add option to reverse PS2 mouse axes and scrolling
feature_rgblight.md Added a new keycode for cycling through RBG modes which reverses directions when shift is hold.
feature_space_cadet.md Restructure the hardware and feature docs to make things easier to find ()
feature_stenography.md Fixed various feature links
feature_tap_dance.md fixed two typos
feature_terminal.md Updates send_string functionality, adds terminal feature ()
feature_thermal_printer.md break up keymaps and quantum keycodes into files by feature
feature_unicode.md Restructure the hardware and feature docs to make things easier to find ()
feature_userspace.md Fixed minor typo in bootloader code
features.md Fix internal links in docs/ ()
flashing.md Updates bootloader settings, adds file size check ()
fuse.txt convert docs to lowercase and underscores
getting_started_build_tools.md Improvements to documentation ()
getting_started_github.md Update getting_started_github.md
getting_started_introduction.md update some docs
getting_started_make_guide.md Fix typo in make example
getting_started_vagrant.md update some docs
glossary.md update glossary; oneshot key = sticky/dead key
hand_wire.md Update hand_wire.md
hardware.md Restructure the hardware and feature docs to make things easier to find ()
hardware_avr.md Restructure the hardware and feature docs to make things easier to find ()
hardware_drivers.md Restructure the hardware and feature docs to make things easier to find ()
hardware_keyboard_guidelines.md use real greater than and less than chars
how_keyboards_work.md Add link to keycodes doc in how_keyboards_work
isp_flashing_guide.md update docs for isp
keycode.txt Docfix ()
keycodes.md Clarify `KC_PWR` vs `KC_POWER`. Fixes .
keycodes_basic.md platform descriptions to match master keycodes.md documentation
keycodes_us_ansi_shifted.md break up keymaps and quantum keycodes into files by feature
keymap.md Fix broken link in docs
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
quantum_keycodes.md Restructure the hardware and feature docs to make things easier to find ()
redirects.json Restructure the hardware and feature docs to make things easier to find ()
understanding_qmk.md Fix internal links in docs/ ()
unit_testing.md Make arguments redo, subproject elimination ()
usb_nkro.txt convert docs to lowercase and underscores

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.