qmk_firmware/docs
2018-10-24 15:03:32 -07:00
..
gitbook/images
_sidebar.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 2018-10-18 15:12:11 -07:00
_summary.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 2018-10-18 15:12:11 -07:00
.nojekyll
arm_debugging.md ARM SWD guide 2018-10-05 11:03:30 -07:00
becoming_a_qmk_collaborator.md
CNAME
compatible_microcontrollers.md
config_options.md Add documentation for Combo feature 2018-10-10 21:36:58 -04:00
contributing.md Update Contrib doc (#4068) 2018-10-06 20:43:37 -04:00
custom_quantum_functions.md Fix Typo in Custom Quantum functions document (led_state) (#4129) 2018-10-13 00:40:42 -07:00
documentation_best_practices.md
documentation_templates.md
eclipse.md
faq_build.md Updates docs - planck 6 and macos instructions (#4201) 2018-10-22 11:19:51 -07:00
faq_debug.md
faq_general.md
faq_keymap.md
faq.md
feature_advanced_keycodes.md Add caveats for shifted characters (#4192) 2018-10-22 14:57:15 -04:00
feature_audio.md
feature_auto_shift.md
feature_backlight.md
feature_bluetooth.md Update Bluetooth docs (#4062) 2018-10-07 11:23:41 -07:00
feature_bootmagic.md
feature_combo.md Add documentation for Combo feature 2018-10-10 21:36:58 -04:00
feature_command.md
feature_dynamic_macros.md
feature_grave_esc.md
feature_hd44780.md
feature_key_lock.md
feature_layouts.md
feature_leader_key.md
feature_macros.md Add tap_code function (#3784) 2018-10-01 20:53:47 -04:00
feature_mouse_keys.md
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgb_matrix.md Make digital rain RGB matrix effect #define configurable. 2018-10-01 12:54:37 -04:00
feature_rgblight.md add a notice into docs/feature_rgblight.md 2018-10-11 17:14:42 -07:00
feature_space_cadet_shift_enter.md
feature_space_cadet_shift.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md Fix formatting in Unicode text 2018-10-09 15:21:08 -04:00
feature_userspace.md Spell-check update for Userspace documentation 2018-09-28 14:39:52 -04:00
features.md
flashing.md Correct small typo 2018-10-01 12:42:05 -04:00
fuse.txt
getting_started_build_tools.md Update the installation script PR (#4167) 2018-10-22 13:24:43 -07:00
getting_started_getting_help.md
getting_started_github.md Fix doc typo 2018-10-15 16:58:03 -07:00
getting_started_introduction.md
getting_started_make_guide.md
getting_started_vagrant.md
hand_wire.md
hardware_avr.md Update hardware config warnings to be more accurate 2018-10-22 14:56:25 -04:00
hardware_drivers.md
hardware_keyboard_guidelines.md
hardware.md
how_keyboards_work.md Fix grammar, typos, and the link to HID specification 2018-10-17 16:51:51 -07:00
index.html
internals_defines.md
internals_gpio_control.md
internals_input_callback_reg.md
internals_midi_device_setup_process.md
internals_midi_device.md
internals_midi_util.md
internals_send_functions.md
internals_sysex_tools.md
isp_flashing_guide.md
keycode.txt
keycodes_basic.md Fix more broken links to the HID spec 2018-10-17 16:51:51 -07:00
keycodes_us_ansi_shifted.md Add caveats for shifted characters (#4192) 2018-10-22 14:57:15 -04:00
keycodes.md
keymap.md
newbs_best_practices.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 2018-10-18 15:12:11 -07:00
newbs_building_firmware.md Fix syntax for windows 2018-10-24 15:03:32 -07:00
newbs_flashing.md
newbs_getting_started.md
newbs_learn_more_resources.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 2018-10-18 15:12:11 -07:00
newbs_testing_debugging.md
newbs.md Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) 2018-10-18 15:12:11 -07:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
power.txt
qmk.css
quantum_keycodes.md
README.md
redirects.json
ref_functions.md Some cleanup of the Useful Functions docs (#4064) 2018-10-19 00:34:40 -04:00
reference_glossary.md Fix more broken links to the HID spec 2018-10-17 16:51:51 -07:00
sidebar.css
sw.js
understanding_qmk.md
unit_testing.md
usb_nkro.txt

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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.