History

skullydazed 7c9d5ace14 Generate API docs from source code comments (#2491 ) * Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly		2018-03-22 02:50:38 -04:00
..
gitbook/images	…
README.md	…
_summary.md	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
api_defines.md	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
api_input_callback_reg.md	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
api_midi_device.md	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
api_midi_device_setup_process.md	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
api_midi_util.md	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
api_send_functions.md	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
api_sysex_tools.md	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
becoming_a_qmk_collaborator.md	…
compatible_microcontrollers.md	…
config_options.md	…
contributing.md	…
custom_quantum_functions.md	Add layer_state_set_* to custom function lists	2018-03-07 17:05:38 -05:00
documentation_best_practices.md	…
documentation_templates.md	…
eclipse.md	…
faq.md	…
faq_build.md	…
faq_debug.md	…
faq_general.md	…
faq_keymap.md	…
feature_advanced_keycodes.md	Add macro for momentarily switching to a layer while some mods are active (#2460 )	2018-03-20 22:59:54 -04:00
feature_audio.md	…
feature_auto_shift.md	Rule to enable Modifiers with Auto-Shift (#2542 )	2018-03-16 16:41:01 -04:00
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	…
feature_macros.md	Add SS_RALT for AltGR usage in macros	2018-03-09 13:15:10 -05:00
feature_mouse_keys.md	…
feature_pointing_device.md	…
feature_ps2_mouse.md	…
feature_rgblight.md	[Proposal?] Allow RGB Underglow to turn off when host is idle/asleep (#2104 )	2018-03-19 23:59:58 -04:00
feature_space_cadet.md	…
feature_space_shift_cadet.md	…
feature_stenography.md	…
feature_swap_hands.md	Add keycodes for swap-hands feature.	2018-03-16 16:33:43 -04:00
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	…
getting_started_github.md	…
getting_started_introduction.md	…
getting_started_make_guide.md	…
getting_started_vagrant.md	…
hand_wire.md	…
hardware.md	…
hardware_avr.md	…
hardware_drivers.md	…
hardware_keyboard_guidelines.md	Added bootloader options	2018-03-20 11:47:22 -04:00
how_keyboards_work.md	…
isp_flashing_guide.md	…
keycode.txt	…
keycodes.md	Add macro for momentarily switching to a layer while some mods are active (#2460 )	2018-03-20 22:59:54 -04:00
keycodes_basic.md	Add CMD and WIN aliases for KC_GUI, GUI(kc), GUI_T(kc), etc.	2018-03-16 16:37:44 -04:00
keycodes_us_ansi_shifted.md	…
keymap.md	…
newbs.md	Move the linux tutorials to an info box on newbs_getting_started	2018-03-06 20:51:26 -08:00
newbs_building_firmware.md	…
newbs_flashing.md	…
newbs_getting_started.md	Move the linux tutorials to an info box on newbs_getting_started	2018-03-06 20:51:26 -08:00
newbs_testing_debugging.md	…
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md	…
power.txt	…
quantum_keycodes.md	…
redirects.json	Disable the glossary linking to fix #2498 (#2499 )	2018-03-08 10:31:08 -08:00
reference_glossary.md	Disable the glossary linking to fix #2498 (#2499 )	2018-03-08 10:31:08 -08:00
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 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 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.