History

Jack Humbert d2ff66a985 Creates a layouts/ folder for keymaps shared between keyboards (#1609 ) * include variables and .h files as pp directives * start layout compilation * split ergodoxes up * don't compile all layouts for everything * might seg fault * reset layouts variable * actually reset layouts * include rules.mk instead * remove includes from rules.mk * update variable setting * load visualizer from path * adds some more examples * adds more layouts * more boards added * more boards added * adds documentation for layouts * use lowercase names for LAYOUT_ * add layout.json files for each layout * add community folder, default keymaps for layouts * touch-up default layouts * touch-up layouts, some keyboard rules.mk * update documentation for layouts * fix up serial/i2c switches		2017-08-23 22:29:07 -04:00
..
gitbook/images	…
README.md	…
_summary.md	Creates a layouts/ folder for keymaps shared between keyboards (#1609 )	2017-08-23 22:29:07 -04:00
adding_a_keyboard_to_qmk.md	…
adding_features_to_qmk.md	…
becoming_a_qmk_collaborator.md	…
compatible_microcontrollers.md	…
config_options.md	…
custom_quantum_functions.md	…
documentation_best_practices.md	…
dynamic_macros.md	…
eclipse.md	…
faq.md	…
faq_build.md	…
faq_debug.md	…
faq_general.md	…
faq_keymap.md	…
feature_audio.md	…
feature_backlight.md	…
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_common_shortcuts.md	…
feature_layouts.md	Creates a layouts/ folder for keymaps shared between keyboards (#1609 )	2017-08-23 22:29:07 -04:00
feature_leader_key.md	…
feature_ps2_mouse.md	…
feature_rgblight.md	…
feature_thermal_printer.md	…
features.md	…
fuse.txt	…
getting_started_build_tools.md	…
getting_started_github.md	…
getting_started_instroduction.md	…
getting_started_make_guide.md	…
getting_started_vagrant.md	…
glossary.md	…
hand_wire.md	…
how_keyboards_work.md	…
isp_flashing_guide.md	…
key_lock.md	…
keycode.txt	…
keycodes.md	…
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
macros.md	…
mouse_keys.md	…
porting_your_keyboard_to_qmk.md	…
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md	…
power.txt	…
quantum_keycodes.md	…
redirects.json	…
space_cadet_shift.md	…
stenography.md	…
tap_dance.md	…
understanding_qmk.md	…
unicode.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), 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.