qmk_firmware/docs
skullydazed 3b525dcf9c
Remove obsolete info.json entries ()
..
gitbook/images RGB improvements ()
README.md Convert all headings to Title Case
_summary.md rename api docs to internals
becoming_a_qmk_collaborator.md Convert all headings to Title Case
compatible_microcontrollers.md Convert all headings to Title Case
config_options.md Fixes and updates to docs ()
contributing.md Trim trailing whitespace
custom_quantum_functions.md Fix custom functions documation for layer_state_set*
documentation_best_practices.md Fix some of the more obvious typos
documentation_templates.md Make arguments redo, subproject elimination ()
eclipse.md Fixed typo of 'confid.h' to 'config.h' ()
faq.md Overhaul the Getting Started section and add a FAQ section
faq_build.md Fixes and updates to docs ()
faq_debug.md Trim trailing whitespace
faq_general.md Convert all headings to Title Case
faq_keymap.md More thoroughly document Bootmagic and Command ()
feature_advanced_keycodes.md Fixes and updates to docs ()
feature_audio.md Fixed typo of 'confid.h' to 'config.h' ()
feature_auto_shift.md Fix typo in autoshift docs: statn ()
feature_backlight.md Clarify that we actually have max 16 total backlight levels
feature_bluetooth.md Format keycode tables
feature_bootmagic.md More thoroughly document Bootmagic and Command ()
feature_command.md More thoroughly document Bootmagic and Command ()
feature_dynamic_macros.md Trim trailing whitespace
feature_grave_esc.md Format keycode tables
feature_key_lock.md Convert all headings to Title Case
feature_layouts.md Clarify the format for layout names
feature_leader_key.md Convert all headings to Title Case
feature_macros.md Add SS_RALT for AltGR usage in macros
feature_mouse_keys.md Fixed dead links ()
feature_pointing_device.md Fix some of the more obvious typos
feature_ps2_mouse.md Trim trailing whitespace
feature_rgblight.md Add rgblist to docs
feature_space_cadet.md Fix some of the more obvious typos
feature_space_shift_cadet.md new planck keymap, new feature - hybrid shift/enter action key (great for small keyboards!) ()
feature_stenography.md Improve state/chord handling and clean up namespace
feature_swap_hands.md Add keycodes for swap-hands feature.
feature_tap_dance.md Trim trailing whitespace
feature_terminal.md Trim trailing whitespace
feature_thermal_printer.md Format keycode tables
feature_unicode.md Fix some of the more obvious typos
feature_userspace.md Add userspace config.h handling to build script ()
features.md Fix some of the more obvious typos
flashing.md Trim trailing whitespace
fuse.txt convert docs to lowercase and underscores
getting_started_build_tools.md Fixed formatting for Fedora example
getting_started_getting_help.md Add a newbie guide for people completely new to QMK ()
getting_started_github.md Convert all headings to Title Case
getting_started_introduction.md Convert all headings to Title Case
getting_started_make_guide.md Trim trailing whitespace
getting_started_vagrant.md Fix some of the more obvious typos
hand_wire.md Trim trailing whitespace
hardware.md Fix some of the more obvious typos
hardware_avr.md backlight breathing overhaul ()
hardware_drivers.md Convert all headings to Title Case
hardware_keyboard_guidelines.md Remove obsolete info.json entries ()
how_keyboards_work.md Convert all headings to Title Case
internals_defines.md rename api docs to internals
internals_input_callback_reg.md rename api docs to internals
internals_midi_device.md rename api docs to internals
internals_midi_device_setup_process.md rename api docs to internals
internals_midi_util.md rename api docs to internals
internals_send_functions.md rename api docs to internals
internals_sysex_tools.md rename api docs to internals
isp_flashing_guide.md Trim trailing whitespace
keycode.txt Trim trailing whitespace
keycodes.md Add macro for momentarily switching to a layer while some mods are active ()
keycodes_basic.md Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc.
keycodes_us_ansi_shifted.md Trim trailing whitespace
keymap.md Fixes and updates to docs ()
newbs.md Move the linux tutorials to an info box on newbs_getting_started
newbs_building_firmware.md warn->danger
newbs_flashing.md Expand Newb Guide flashing document ()
newbs_getting_started.md Move the linux tutorials to an info box on newbs_getting_started
newbs_testing_debugging.md Add a newbie guide for people completely new to QMK ()
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md Fix some of the more obvious typos
power.txt Trim trailing whitespace
quantum_keycodes.md Trim trailing whitespace
redirects.json Disable the glossary linking to fix ()
reference_glossary.md Disable the glossary linking to fix ()
understanding_qmk.md Fixed dead links ()
unit_testing.md Trim trailing whitespace
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.