6d6d91c834
* add temporary test code rgblight-macro-test1.[ch] * rgblight.h : mode auto numberring and auto generate mode name symbol No change in build result. * rgblight.c use RGBLIGHT_MODE_xxx symbols No change in build result. * quantum.c use RGBLIGHT_MODE_xxx symbols No change in build result. * fix build break. when RGB_MATRIX_ENABLE defined * add temporary test code rgblight-macro-test2.[ch] * modify rgblight_mode_eeprom_helper() and rgblight_sethsv_eeprom_helper() * modify rgblight_task() * configurable each effect compile on/off in config.h * update docs/feature_rgblight.md * fix conflict. docs/feature_rgblight.md * remove temporary test code rgblight-macro-test*.[ch] * fix comment typo. * remove old mode number from comment * update docs/feature_rgblight.md about effect mode * Revert "update docs/feature_rgblight.md about effect mode" This reverts commit 43890663fcc9dda1899df7a37d382fc38b1a6d6d. * some change docs/feature_rgblight.md * fix typo * docs/feature_rgblight.md update: revise mode number table |
||
---|---|---|
.. | ||
gitbook/images | ||
.nojekyll | ||
_sidebar.md | ||
_summary.md | ||
becoming_a_qmk_collaborator.md | ||
CNAME | ||
compatible_microcontrollers.md | ||
config_options.md | ||
contributing.md | ||
custom_quantum_functions.md | ||
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 | ||
feature_audio.md | ||
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_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 | ||
feature_rgblight.md | ||
feature_space_cadet_shift.md | ||
feature_space_cadet_shift_enter.md | ||
feature_stenography.md | ||
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 | ||
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 | ||
how_keyboards_work.md | ||
index.html | ||
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 | ||
keycodes_basic.md | ||
keycodes_us_ansi_shifted.md | ||
keymap.md | ||
newbs.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
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.