qmk_firmware/docs
2017-08-11 16:54:10 -04:00
..
gitbook/images
_summary.md Added initial key lock documentation. 2017-08-08 10:02:53 -04:00
adding_a_keyboard_to_qmk.md
adding_features_to_qmk.md
basic_how_keyboards_work.md
basic_keycodes.md add short name for locking mods to docs. 2017-08-03 23:10:31 -04:00
becoming_a_qmk_collaborator.md
build_environment_setup.md Change installation of avr-libc to avr-gcc, now that avr-libc is integrated into the avr-gcc build 2017-08-08 10:03:19 -04:00
compatible_microcontrollers.md
config_options.md
custom_quantum_functions.md Fix minor formatting issue. 2017-07-23 15:10:27 -04:00
documentation_best_practices.md Add terminal examples to doc best practices 2017-07-08 22:39:17 -07:00
dynamic_macros.md
eclipse.md
faq.md Rearrange the faq a bit 2017-07-08 20:01:35 -07:00
faq_build.md
faq_keymap.md add description of new option to docs and add option (commented out) into template. 2017-08-11 16:54:10 -04:00
features.md Rename docs/features/README.md to docs/features.md 2017-07-17 15:01:11 -04:00
fuse.txt
glossary.md Invites contributions 2017-07-10 20:51:46 -04:00
hand_wire.md
how_to_github.md
isp_flashing_guide.md
key_functions.md
key_lock.md Added support for locking One Shot modifiers. 2017-08-08 10:02:53 -04:00
keycode.txt
keycodes.md
keymap.md
leader_key.md
macros.md Merge branch 'master' into docs 2017-07-06 18:43:22 -07:00
make_instructions.md Added initial key lock documentation. 2017-08-08 10:02:53 -04:00
modding_your_keyboard.md adds option for alt pitch standards 2017-07-24 12:45:34 -04:00
mouse_keys.md Merge branch 'master' into docs 2017-07-06 18:43:22 -07:00
porting_your_keyboard_to_qmk.md fix section in porting guide that refered to Makefile instead of rules.mk 2017-08-02 22:00:49 -04:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
power.txt
qmk_overview.md
quantum_keycodes.md Added initial key lock documentation. 2017-08-08 10:02:53 -04:00
README.md
space_cadet_shift.md
stenography.md Fix typo in docs. 2017-07-27 16:10:36 -04:00
tap_dance.md
understanding_qmk.md
unicode.md
unit_testing.md
usb_nkro.txt
vagrant_guide.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.