qmk_firmware/docs
MechMerlin efe360464d Contribute the MechMerlin QMK Configurator docs (#4986)
* first pass at configurator docs

* edit existing docs to make reference to QMK Configurator

* contribute my own newb guide to QMK officially from https://github.com/mechmerlin/qmk_setup/blob/master/qmk_configurator.md

* Update docs/newbs_building_firmware_configurator.md

Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>

* Update docs/newbs_building_firmware_configurator.md

Big red box!

Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>

* Update docs/newbs_building_firmware_configurator.md

Big red box

Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>

* Update docs/newbs_building_firmware_configurator.md

Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>

* Update docs/newbs_building_firmware_configurator.md

Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>

* Update docs/newbs_building_firmware_configurator.md

Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>

* Update docs/newbs_building_firmware_configurator.md

Co-Authored-By: mechmerlin <30334081+mechmerlin@users.noreply.github.com>
2019-01-28 17:31:33 -08:00
..
gitbook/images
zh Adds Proton C Conversion (#4661) 2019-01-10 08:22:57 -08:00
.nojekyll
_summary.md Adds Proton C Conversion (#4661) 2019-01-10 08:22:57 -08:00
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 Fix Command feature: use get_mods() instead of keyboard_report->mods (#4955) 2019-01-27 00:28:40 -08:00
contributing.md Update Contrib doc (#4068) 2018-10-06 20:43:37 -04:00
custom_quantum_functions.md Tidy up IS_{,HOST_}LED_{ON,OFF} macros (#4894) 2019-01-20 20:16:36 -08:00
documentation_best_practices.md
documentation_templates.md
eclipse.md
faq.md
faq_build.md Make sure that avr-gcc@7 gets linked into the path on MacOS. 2018-11-12 12:16:43 -08:00
faq_debug.md
faq_general.md
faq_keymap.md Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 2018-12-01 08:21:06 -08:00
feature_advanced_keycodes.md Add C(), A() and G() to match already existing S() (#4673) 2019-01-25 13:12:48 -08:00
feature_audio.md Docs: Clarify audio keycodes (#4620) 2018-12-14 10:43:24 -08:00
feature_auto_shift.md
feature_backlight.md Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769) 2019-01-28 16:57:56 -08:00
feature_bluetooth.md Update Bluetooth docs (#4062) 2018-10-07 11:23:41 -07:00
feature_bootmagic.md Update feature_bootmagic.md (#4290) 2018-10-30 08:37:08 -07:00
feature_combo.md fix example to reflect caveat 2018-11-06 00:38:44 -05:00
feature_command.md Fix Command feature: use get_mods() instead of keyboard_report->mods (#4955) 2019-01-27 00:28:40 -08:00
feature_dynamic_macros.md
feature_encoders.md Fix Encoder documentation (#4861) 2019-01-18 07:33:43 -08:00
feature_grave_esc.md
feature_hd44780.md
feature_key_lock.md
feature_layouts.md
feature_leader_key.md Fix up process_leader to be a bit more optimized (#4662) 2018-12-20 16:54:06 -08:00
feature_macros.md Fix up tap_code functionality (#4609) 2018-12-14 09:01:58 -08:00
feature_mouse_keys.md
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgb_matrix.md Allows disabling rgb effects in userspace (#4422) 2018-11-18 08:24:41 -08:00
feature_rgblight.md Added noeeprom versions of set hue, sat, val, and step 2018-12-13 18:30:15 -08:00
feature_space_cadet_shift.md
feature_space_cadet_shift_enter.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md Remove userspace info from Quad-Function Tap Dance example (#4631) 2018-12-14 07:36:38 -08:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774) 2019-01-07 12:56:57 -08:00
feature_userspace.md Spell-check update for Userspace documentation 2018-09-28 14:39:52 -04:00
features.md Fix Encoder documentation (#4861) 2019-01-18 07:33:43 -08:00
flashing.md Instructions on how to flash via STM32 bootloader (#4316) 2018-11-03 13:08:05 -04:00
fuse.txt
getting_started_build_tools.md docs: Add Manjaro/Arch dependencies on getting started page (#2701) 2019-01-10 08:28:52 -08: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 Simplify split_common Code significantly (#4772) 2019-01-17 10:08:14 -08: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
how_keyboards_work.md Fix grammar, typos, and the link to HID specification 2018-10-17 16:51:51 -07:00
i2c_driver.md Remove duplicate row from Available functions table in i2c_driver doc (#4416) 2018-11-13 08:27:46 -08:00
index.html Adds Proton C Conversion (#4661) 2019-01-10 08:22:57 -08:00
internals_defines.md
internals_gpio_control.md Grammatical fixes for GPIO Control doc (#4869) 2019-01-17 22:13:09 -08:00
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 Fix a typo in link to the Pro Micro ISP firmware 2019-01-24 16:13:18 -08:00
keycodes.md Add C(), A() and G() to match already existing S() (#4673) 2019-01-25 13:12:48 -08:00
keycodes_basic.md Add new brightness aliases to keycodes_basic.md 2019-01-17 18:35:45 -08:00
keycodes_us_ansi_shifted.md Add caveats for shifted characters (#4192) 2018-10-22 14:57:15 -04:00
keymap.md
LANGS.md Second try at configuring i18n for docsify and gitbook (#4531) 2018-12-02 15:12:54 -05:00
newbs.md Contribute the MechMerlin QMK Configurator docs (#4986) 2019-01-28 17:31:33 -08:00
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_building_firmware_configurator.md Contribute the MechMerlin QMK Configurator docs (#4986) 2019-01-28 17:31:33 -08:00
newbs_flashing.md
newbs_getting_started.md Contribute the MechMerlin QMK Configurator docs (#4986) 2019-01-28 17:31:33 -08:00
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 Fixed docs/newbs_testing_debugging.md and tmk_core/common/print.h 2018-11-27 14:40:19 -05:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
power.txt
proton_c_conversion.md Adds Proton C Conversion (#4661) 2019-01-10 08:22:57 -08:00
qmk.css
quantum_keycodes.md Add EEPROM_RESET keycode to core code (#4234) 2018-11-06 00:38:18 -05:00
README.md
redirects.json
ref_functions.md Add tap_random_base64 and software timer info to Useful Functions doc (#4360) 2018-12-01 08:21:06 -08:00
reference_configurator_support.md Docs: Supporting a keyboard in the QMK Configurator (#4396) 2018-11-14 18:32:28 -08:00
reference_glossary.md Fix more broken links to the HID spec 2018-10-17 16:51:51 -07:00
sidebar.css
support.md Add support for PR and Issue templates to QMK_firmware GitHub (#4494) 2018-12-07 16:51:27 -08:00
sw.js
understanding_qmk.md Improve consistency in UNICODEMAP code and docs, update docs/understanding_qmk (#4774) 2019-01-07 12:56:57 -08:00
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.