qmk-dactyl-manuform-a/docs
fauxpark 170261328e
Add language prefixes to docs sidebar entries and readmes (#7406)
* Add language prefixes to docs sidebar entries and readmes

* Remove prefix where it doesn't belong
2019-11-26 18:22:13 +11:00
..
ChangeLog
de Add language prefixes to docs sidebar entries and readmes (#7406) 2019-11-26 18:22:13 +11:00
es Add language prefixes to docs sidebar entries and readmes (#7406) 2019-11-26 18:22:13 +11:00
fr-fr Add language prefixes to docs sidebar entries and readmes (#7406) 2019-11-26 18:22:13 +11:00
gitbook/images
he-il Add language prefixes to docs sidebar entries and readmes (#7406) 2019-11-26 18:22:13 +11:00
ja [Docs] Update japanese translation of newbs.md and related documents. (#7431) 2019-11-21 02:36:38 -08:00
ru-ru [Docs] Encourage newbs to not download the repo as a zip (#7353) 2019-11-14 11:37:18 -08:00
zh-cn Add language prefixes to docs sidebar entries and readmes (#7406) 2019-11-26 18:22:13 +11:00
.nojekyll
CNAME
README.md [Docs] Encourage newbs to not download the repo as a zip (#7353) 2019-11-14 11:37:18 -08:00
_langs.md [Docs] Fix Japanese country flag (#7407) 2019-11-19 00:38:50 -08:00
_summary.md Set up language fallback for docs, and update translation guidelines (#7403) 2019-11-23 16:07:15 +00:00
arm_debugging.md
becoming_a_qmk_collaborator.md
breaking_changes.md
cli.md Add CLI command for flashing a keyboard 2019-11-15 23:06:07 -08:00
cli_configuration.md
cli_development.md Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
coding_conventions_c.md [Docs] Fix incorrect spacing on Coding Conventions page (#7058) 2019-10-18 16:59:03 -07:00
coding_conventions_python.md [Docs] Fix dunder names being accidentally bolded (#7217) 2019-10-30 21:56:59 -07:00
compatible_microcontrollers.md [Doc] Tidy up compatible MCUs docs (#7295) 2019-11-08 18:34:25 -08:00
config_options.md Unify RGB and RGBW commands (#7297) 2019-11-09 15:51:39 +00:00
contributing.md Set up language fallback for docs, and update translation guidelines (#7403) 2019-11-23 16:07:15 +00:00
custom_quantum_functions.md Update led_update_kb example (#7451) 2019-11-23 15:37:25 +00:00
documentation_best_practices.md
documentation_templates.md Doc fix to conform with #7221 (#7392) 2019-11-17 16:04:44 +00:00
driver_installation_zadig.md Add a short explanation to Zadig the troubleshooting section (#7110) 2019-10-22 14:05:33 +11:00
faq.md
faq_build.md
faq_debug.md [Docs] Modified the description about setting debug_enable in `docs/faq_debug.md`. (#7394) 2019-11-17 17:09:57 -08:00
faq_general.md
faq_keymap.md Remove obsolete note about media keys in MacOS (#6631) 2019-10-30 10:39:38 +11:00
feature_advanced_keycodes.md fix feature_advanced_keycodes.md's link (#7421) 2019-11-20 13:48:05 +00:00
feature_audio.md
feature_auto_shift.md Smallish overhaul of Auto-Shift feature (#6067) 2019-11-03 09:52:01 -08:00
feature_backlight.md Initial migration of software PWM backlight (#6709) 2019-11-02 21:20:03 +00:00
feature_bluetooth.md Update feature_bluetooth.md (#7193) 2019-10-30 09:43:01 +11:00
feature_bootmagic.md
feature_combo.md
feature_command.md
feature_debounce_type.md Update debounce docs (#7355) 2019-11-14 18:54:34 +00:00
feature_dip_switch.md
feature_dynamic_macros.md [Core] Convert Dynamic Macro to a Core Feature (#5948) 2019-11-04 22:59:13 -08:00
feature_encoders.md
feature_grave_esc.md
feature_haptic_feedback.md Improvements to Solenoid feature (#7369) 2019-11-15 22:27:46 +00:00
feature_hd44780.md Remove build option firmware size impacts (#6947) 2019-10-18 18:14:49 -07:00
feature_key_lock.md
feature_layouts.md
feature_leader_key.md Send string keycode tweaks (#7471) 2019-11-25 23:16:58 -08:00
feature_led_matrix.md
feature_macros.md Send string keycode tweaks (#7471) 2019-11-25 23:16:58 -08:00
feature_mouse_keys.md
feature_oled_driver.md Adds raw write functions to the OLED driver (#7237) 2019-11-03 14:34:47 -08:00
feature_pointing_device.md
feature_ps2_mouse.md
feature_rgb_matrix.md ARM - ws2812 bitbang (#7173) 2019-11-07 13:10:29 +00:00
feature_rgblight.md Fix typo and code indentation (#7410) 2019-11-19 13:41:35 +00:00
feature_space_cadet.md
feature_split_keyboard.md Update split i2c docs for example of when pull-ups are required (#7143) 2019-10-28 18:10:25 +00:00
feature_stenography.md
feature_swap_hands.md
feature_tap_dance.md [Docs] Explain Tap Dance interruption (#5520) 2019-11-16 09:20:49 -08:00
feature_terminal.md Remove build option firmware size impacts (#6947) 2019-10-18 18:14:49 -07:00
feature_thermal_printer.md
feature_unicode.md
feature_userspace.md Send string keycode tweaks (#7471) 2019-11-25 23:16:58 -08:00
feature_velocikey.md
features.md
flashing.md [Docs] Update flashing information to include :flash target (#6999) 2019-10-29 13:15:03 -07:00
flashing_bootloadhid.md
fuse.txt
getting_started_build_tools.md [Docs] Encourage newbs to not download the repo as a zip (#7353) 2019-11-14 11:37:18 -08:00
getting_started_getting_help.md
getting_started_github.md
getting_started_introduction.md
getting_started_make_guide.md [Docs] Update flashing information to include :flash target (#6999) 2019-10-29 13:15:03 -07:00
getting_started_vagrant.md [Docs] Update getting_started_vagrant.md (#7203) 2019-10-30 11:53:48 -07:00
hand_wire.md [Docs] Fixed internal links on Handwire page (#7154) 2019-10-25 18:16:17 -07:00
hardware.md
hardware_avr.md Remove apostrophe from various abbreviations' plural forms (#7050) 2019-10-22 13:47:43 +01:00
hardware_drivers.md ARM - ws2812 bitbang (#7173) 2019-11-07 13:10:29 +00:00
hardware_keyboard_guidelines.md
how_keyboards_work.md Update URL for `60-keyboard.hwdb` (#7185) 2019-10-28 02:41:22 +00:00
i2c_driver.md
index.html Set up language fallback for docs, and update translation guidelines (#7403) 2019-11-23 16:07:15 +00:00
internals_defines.md
internals_gpio_control.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
keycodes.md [Core] Convert Dynamic Macro to a Core Feature (#5948) 2019-11-04 22:59:13 -08:00
keycodes_basic.md Remove obsolete note about media keys in MacOS (#6631) 2019-10-30 10:39:38 +11:00
keycodes_us_ansi_shifted.md Backslash-escape pipe character in keycode lists (#7157) 2019-10-26 06:10:03 +01:00
keymap.md
newbs.md
newbs_best_practices.md [Docs] fix broken link in docs/newbs_best_practices.md (#7430) 2019-11-21 01:02:15 -08:00
newbs_building_firmware.md
newbs_building_firmware_configurator.md
newbs_flashing.md [Docs] Update flashing information to include :flash target (#6999) 2019-10-29 13:15:03 -07:00
newbs_getting_started.md
newbs_learn_more_resources.md
newbs_testing_debugging.md [Docs] Replace Switch Hitter link with Wayback Machine link (#7009) 2019-10-15 23:21:05 +01:00
other_eclipse.md
other_vscode.md
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md
power.txt
proton_c_conversion.md Use task driven PWM for CTPC until ARM can provide automatic configuration (#6928) 2019-11-02 21:21:00 +00:00
qmk.css
quantum_keycodes.md
redirects.json
ref_functions.md
reference_configurator_support.md
reference_glossary.md Remove apostrophe from various abbreviations' plural forms (#7050) 2019-10-22 13:47:43 +01:00
reference_info_json.md
sidebar.css
support.md
sw.js
translating.md fix link in docs/translating.md (#7474) 2019-11-25 00:37:08 +00:00
understanding_qmk.md Remove apostrophe from various abbreviations' plural forms (#7050) 2019-10-22 13:47:43 +01:00
unit_testing.md
usb_nkro.txt
ws2812_driver.md ARM - ws2812 bitbang (#7173) 2019-11-07 13:10:29 +00:00

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 clone it directly with git clone https://github.com/qmk/qmk_firmware. Do not download the zip or tar files; a git repository is required to download the submodules in order to compile.

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.