History

Evan Travers 0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337 ) If you run `brew install avr-gcc`, you get a version that has compatibility issues with LUFA. I updated the getting started guide for osx, the qmk_install setup script, and added a section to the FAQ for folks like me who accidentally updated avr-gcc past 7.		2018-07-07 17:37:37 -07:00
..
gitbook/images	…
.nojekyll	…
CNAME	Create CNAME	2018-05-21 16:29:37 -04:00
README.md	Fix readme and contributing hyperlinks	2018-05-24 00:00:20 -04:00
_sidebar.md	Make sure new features (RGB Matrix) are actually listed	2018-05-15 22:35:17 -04:00
_summary.md	…
becoming_a_qmk_collaborator.md	…
compatible_microcontrollers.md	…
config_options.md	Add documentation for TAPPING_FORCE_HOLD (#2957 ) (#3320 )	2018-07-06 08:12:46 -07:00
contributing.md	Fix readme and contributing hyperlinks	2018-05-24 00:00:20 -04:00
custom_quantum_functions.md	Add Suspend functions (#3112 )	2018-06-03 17:57:35 -04:00
documentation_best_practices.md	…
documentation_templates.md	…
eclipse.md	…
faq.md	…
faq_build.md	Instruct macos users to use avr-gcc@7 (#3337 )	2018-07-07 17:37:37 -07:00
faq_debug.md	…
faq_general.md	…
faq_keymap.md	…
feature_advanced_keycodes.md	Add documentation for TAPPING_FORCE_HOLD (#2957 ) (#3320 )	2018-07-06 08:12:46 -07:00
feature_audio.md	updated music mask	2018-05-08 17:18:15 -04:00
feature_auto_shift.md	…
feature_backlight.md	…
feature_bluetooth.md	…
feature_bootmagic.md	…
feature_command.md	…
feature_dynamic_macros.md	…
feature_grave_esc.md	…
feature_key_lock.md	…
feature_layouts.md	…
feature_leader_key.md	Refresh & improve leader documentation page (#2990 )	2018-05-26 11:29:02 -07:00
feature_macros.md	…
feature_mouse_keys.md	…
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rgb_matrix.md	Addition of hard brigtness limit for RGB_Matrix (#3299 )	2018-07-03 12:52:04 -04:00
feature_rgblight.md	Add rgblight mode 35 (R,G,B test mode) (#3114 )	2018-06-04 08:10:39 -07:00
feature_space_cadet.md	…
feature_space_shift_cadet.md	…
feature_stenography.md	…
feature_swap_hands.md	…
feature_tap_dance.md	fix a few simple typos (#3068 )	2018-05-28 20:23:33 -07:00
feature_terminal.md	…
feature_thermal_printer.md	…
feature_unicode.md	…
feature_userspace.md	…
features.md	Make sure new features (RGB Matrix) are actually listed	2018-05-15 22:35:17 -04:00
flashing.md	…
fuse.txt	…
getting_started_build_tools.md	Instruct macos users to use avr-gcc@7 (#3337 )	2018-07-07 17:37:37 -07:00
getting_started_getting_help.md	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	Added propper support for Lets split vitamins (#2559 )	2018-05-09 09:14:30 -07:00
getting_started_vagrant.md	…
hand_wire.md	…
hardware.md	…
hardware_avr.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	Remove bootloader key as it is no longer used (#3093 )	2018-06-01 12:26:48 -07:00
how_keyboards_work.md	…
index.html	override hamburger placement	2018-05-14 08:56:41 -07:00
internals_defines.md	…
internals_input_callback_reg.md	…
internals_midi_device.md	…
internals_midi_device_setup_process.md	…
internals_midi_util.md	…
internals_send_functions.md	…
internals_sysex_tools.md	…
isp_flashing_guide.md	…
keycode.txt	…
keycodes.md	Clean up SEND_STRING keycodes and add media keys (#3214 )	2018-06-28 08:55:04 -04:00
keycodes_basic.md	Clean up SEND_STRING keycodes and add media keys (#3214 )	2018-06-28 08:55:04 -04:00
keycodes_us_ansi_shifted.md	…
keymap.md	…
newbs.md	…
newbs_building_firmware.md	…
newbs_flashing.md	…
newbs_getting_started.md	added some helpful notes to the documentation (#2981 )	2018-05-22 12:48:33 -07:00
newbs_testing_debugging.md	…
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md	…
power.txt	…
qmk.css	…
quantum_keycodes.md	…
redirects.json	…
reference_glossary.md	…
sidebar.css	override hamburger placement	2018-05-14 08:56:41 -07:00
sw.js	…
understanding_qmk.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 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.