1
0
Fork 0
qmk_firmware/docs
Michael Pio 292a87ad04 Instructions on how to flash via STM32 bootloader ()
* Add instructions on flashing ARM keyboards with default STM32 bootloader

* fixed typo; added note suggestion to step 4
2018-11-03 13:08:05 -04:00
..
gitbook/images
.nojekyll
_sidebar.md
_summary.md add support for encoders to core 2018-10-26 14:24:13 -07:00
arm_debugging.md
becoming_a_qmk_collaborator.md Tweak the wording in "Becoming a QMK Collaborator" 2018-08-30 07:39:58 -04:00
CNAME
compatible_microcontrollers.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
config_options.md
contributing.md Update Contrib doc () 2018-10-06 20:43:37 -04:00
custom_quantum_functions.md
documentation_best_practices.md
documentation_templates.md Update Document Templates to reflect newer wording and URLs () 2018-09-28 12:04:30 -04:00
eclipse.md
faq.md
faq_build.md Updates docs - planck 6 and macos instructions () 2018-10-22 11:19:51 -07:00
faq_debug.md
faq_general.md Convert all headings to Title Case 2017-12-09 10:46:11 -05:00
faq_keymap.md
feature_advanced_keycodes.md
feature_audio.md Add On/Off keycodes 2018-09-25 13:28:36 -07:00
feature_auto_shift.md
feature_backlight.md
feature_bluetooth.md Update Bluetooth docs () 2018-10-07 11:23:41 -07:00
feature_bootmagic.md
feature_combo.md Add key caveat to combos doc 2018-10-27 00:18:22 -04:00
feature_command.md Docs: Fix Command docs escaping () 2018-07-29 21:08:59 -07:00
feature_dynamic_macros.md Docs: Adjust dynamic macro docs to include more than the planck () 2018-07-29 08:59:39 -07:00
feature_encoders.md add better example 2018-10-26 14:24:13 -07:00
feature_grave_esc.md Docs: Format Grave Escape documentation () 2018-07-31 17:40:55 -07:00
feature_hd44780.md
feature_key_lock.md
feature_layouts.md
feature_leader_key.md
feature_macros.md
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
feature_space_cadet_shift.md
feature_space_cadet_shift_enter.md
feature_stenography.md Improve state/chord handling and clean up namespace 2018-04-07 17:12:44 -04:00
feature_swap_hands.md
feature_tap_dance.md
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md
features.md
flashing.md
fuse.txt
getting_started_build_tools.md
getting_started_getting_help.md Replace gitter links with Discord. () 2018-07-11 00:01:56 -07:00
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md Lets split eh () 2018-07-16 22:25:02 -04:00
getting_started_vagrant.md
hand_wire.md
hardware.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 Remove bootloader key as it is no longer used () 2018-06-01 12:26:48 -07:00
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.md rename api docs to internals 2018-03-26 11:43:37 -07:00
internals_midi_device_setup_process.md rename api docs to internals 2018-03-26 11:43:37 -07:00
internals_midi_util.md
internals_send_functions.md
internals_sysex_tools.md
isp_flashing_guide.md
keycode.txt
keycodes.md
keycodes_basic.md
keycodes_us_ansi_shifted.md
keymap.md
newbs.md
newbs_best_practices.md
newbs_building_firmware.md
newbs_flashing.md
newbs_getting_started.md
newbs_learn_more_resources.md
newbs_testing_debugging.md
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
reference_glossary.md
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.