darkkirb/qmk_firmware
1
0
Fork 0
forked from mirrors/qmk_firmware
Code Issues Pull requests Projects Releases Packages Wiki Activity
qmk_firmware/docs
History
James Churchill 37932c293c Next set of split_common changes (#4974) 
* Update split_common to use standard i2c drivers

* Eliminate RGB_DIRTY/BACKLIT_DIRTY

* Fix avr i2c_master error handling

* Fix i2c_slave addressing

* Remove unneeded timeout on i2c_stop()

* Fix RGB I2C transfers

* Remove incorrect comment
2019-03-12 10:23:28 -07:00
..
gitbook/images
zh Adds Proton C Conversion (#4661) 2019-01-10 08:22:57 -08:00
.nojekyll
_summary.md Add LED Matrix to Features list for easy reference (#5280) 2019-03-03 15:29:29 -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 Clean up debounce a bit (#5255) 2019-03-04 07:44:46 -08:00
contributing.md [Docs] Add Tap Dance example to the docs (#5326) 2019-03-07 12:30:02 -08:00
custom_quantum_functions.md [Docs] Fix function signature (layer_state_set_*) (#5313) 2019-03-04 22:08:09 -08:00
documentation_best_practices.md
documentation_templates.md Update Document Templates to reflect newer wording and URLs (#4006) 2018-09-28 12:04:30 -04:00
eclipse.md
faq.md
faq_build.md [Docs] Add section about EEPROM on ARM (#5070) 2019-02-18 08:50:22 -08:00
faq_debug.md
faq_general.md
faq_keymap.md Replace instances of KEYMAP with LAYOUT 2019-02-21 23:19:26 -08:00
feature_advanced_keycodes.md [Docs] Add Tap Dance example to the docs (#5326) 2019-03-07 12:30:02 -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 [Docs] Bootmagic Lite Caveat (#5069) 2019-02-06 16:43:47 -08:00
feature_combo.md added missing ; on example (#5089) 2019-02-09 09:18:08 -08:00
feature_command.md Change Command keycode defaults to match corresponding Bootmagic codes (#5078) 2019-02-17 22:23:32 -08:00
feature_debounce_type.md Clean up debounce a bit (#5255) 2019-03-04 07:44:46 -08:00
feature_dynamic_macros.md
feature_encoders.md Improve Encoder documentation (#5130) 2019-02-14 21:00:57 -08:00
feature_grave_esc.md Update KC_GESC documentation (#5053) 2019-02-15 06:50:28 -08:00
feature_haptic_feedback.md Haptic feedback generalized - DRV2605 and solenoids (#4939) 2019-02-16 18:39:30 -08:00
feature_hd44780.md
feature_key_lock.md
feature_layouts.md Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08:00
feature_leader_key.md Fix up process_leader to be a bit more optimized (#4662) 2018-12-20 16:54:06 -08:00
feature_led_matrix.md Add documentation for led matrix 2019-02-10 15:37:12 -08:00
feature_macros.md Replace instances of KEYMAP with LAYOUT 2019-02-21 23:19:26 -08:00
feature_mouse_keys.md
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgb_matrix.md [Docs] Fix typo in RGB Matrix Driver configuration (#5182) 2019-02-19 20:49:22 -08:00
feature_rgblight.md Add support for using ranges for RGB (#4981) 2019-02-15 06:52:04 -08:00
feature_space_cadet_shift.md Improvements to Space Cadet Shift (#3856) 2019-02-05 10:36:26 -08:00
feature_space_cadet_shift_enter.md
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md [Docs] Add Tap Dance example to the docs (#5326) 2019-03-07 12:30:02 -08:00
feature_terminal.md
feature_thermal_printer.md
feature_unicode.md [Docs] Add note about using Unicode Hex Input (#5248) 2019-02-28 12:15:38 -08:00
feature_userspace.md [Docs] Update the KC_MAKE example in Userspace docs (#5337) 2019-03-08 07:56:08 -08:00
feature_velocikey.md Velocikey: Match RGB animation speed to typing speed (#3754) 2019-02-21 07:22:46 -08:00
features.md Add LED Matrix to Features list for easy reference (#5280) 2019-03-03 15:29:29 -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 getting_started_build_tools: dfu-{util,programmer} now available from arch repo 2019-03-08 10:18:21 -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 Clean up debounce a bit (#5255) 2019-03-04 07:44:46 -08:00
getting_started_vagrant.md
hand_wire.md Add more "decent" text editors (#5308) 2019-03-05 07:31:54 -08:00
hardware.md
hardware_avr.md Remove CUSTOM_MATRIX option from diode direction (#5090) 2019-02-18 08:49:51 -08:00
hardware_drivers.md
hardware_keyboard_guidelines.md Clarify LAYOUT vs LAYOUT_all 2019-02-08 15:13:20 -08:00
how_keyboards_work.md Fix grammar, typos, and the link to HID specification 2018-10-17 16:51:51 -07:00
i2c_driver.md Next set of split_common changes (#4974) 2019-03-12 10:23:28 -07: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 Replace instances of KEYMAP with LAYOUT 2019-02-21 23:19:26 -08:00
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 Grammar cleanup of Flashing Your Keyboard Newbs Guide (#5201) 2019-02-21 09:24:59 -08:00
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 Add docs on using keyboard_post_init_user to enable debug modes 2019-02-16 21:20:18 -08:00
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md Replace instances of KEYMAP with LAYOUT 2019-02-21 23:19:26 -08:00
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
reference_info_json.md Add label to the info.json reference 2019-02-08 15:13:20 -08: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 Replace instances of KEYMAP with LAYOUT 2019-02-21 23:19:26 -08:00
unit_testing.md
usb_nkro.txt

README.md

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.