History

Jack Humbert 7ad924bae5 Updates send_string functionality, adds terminal feature (#1657 ) * implement basic terminal stuff * modify send_string to read normal strings too * add files bc yeah. working pgm detected * pgm detection apparently not working * adds send string keycodes, additional keycode support in send string * implement arguments * [terminal] add help command * [terminal] adds keycode and keymap functions * [terminal] adds nop.h, documentation * update macro docs		2017-09-12 00:43:10 -04:00
..
gitbook/images	RGB improvements (#1684 )	2017-09-06 14:49:19 -07:00
README.md	…
_summary.md	Updates send_string functionality, adds terminal feature (#1657 )	2017-09-12 00:43:10 -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	Update feature_common_shortcuts.md	2017-09-05 13:11:43 -04:00
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	RGB improvements (#1684 )	2017-09-06 14:49:19 -07:00
feature_terminal.md	Updates send_string functionality, adds terminal feature (#1657 )	2017-09-12 00:43:10 -04:00
feature_thermal_printer.md	…
features.md	…
fuse.txt	…
getting_started_build_tools.md	Update mac guide (#1665 )	2017-09-06 10:36:47 -07:00
getting_started_github.md	…
getting_started_instroduction.md	…
getting_started_make_guide.md	Remove all Makefiles from the keyboards directory. (#1660 )	2017-09-08 13:47:50 -04:00
getting_started_vagrant.md	…
glossary.md	…
hand_wire.md	Remove all Makefiles from the keyboards directory. (#1660 )	2017-09-08 13:47:50 -04:00
how_keyboards_work.md	Add link to keycodes doc in how_keyboards_work	2017-08-18 12:49:55 -04:00
isp_flashing_guide.md	…
key_lock.md	…
keycode.txt	…
keycodes.md	…
keycodes_basic.md	…
keycodes_us_ansi_shifted.md	…
keymap.md	…
macros.md	Updates send_string functionality, adds terminal feature (#1657 )	2017-09-12 00:43:10 -04:00
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	validates json	2017-08-19 08:35:14 -04:00
space_cadet_shift.md	…
stenography.md	Add compile error if too many endpoints are defined for the ATmega32U4.	2017-08-20 11:51:57 -04:00
tap_dance.md	…
understanding_qmk.md	…
unicode.md	add UC_OSX_RALT to make unicode use the Right Alt key on OSX	2017-08-30 11:38:03 -04:00
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.