Kezdőlap Felfedezés Súgó
Regisztráció Bejelentkezés
HuiJun
/
qmk_firmware
1
0
Másolás 0
Fájlok Problémák 0 Beolvasztási kérések 0 Wiki
Fa: cffaf0acf4
Branch-ok Tag-ek
qmk_firmware
/
docs
skullY da24a34efb First pass at reorganizing docs 6 éve
..
gitbook 4580d3a730 RGB improvements (#1684) 7 éve
.nojekyll 9e5676650e Use docsfy to replace gitbook 7 éve
CNAME 4d26137e2a Create CNAME 7 éve
README.md 73ddb764cc Fix readme and contributing hyperlinks 7 éve
_sidebar.md da24a34efb First pass at reorganizing docs 6 éve
_summary.md da24a34efb First pass at reorganizing docs 6 éve
becoming_a_qmk_collaborator.md 7b0356d1d4 Convert all headings to Title Case 7 éve
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case 7 éve
config_options.md 09759c20ae Document FIRMWARE_FORMAT (#3631) 6 éve
contributing.md 48913153c3 Replace gitter links with Discord. (#3368) 7 éve
custom_quantum_functions.md 48913153c3 Replace gitter links with Discord. (#3368) 7 éve
documentation_best_practices.md 303f425c6b Fix up info boxes. 7 éve
documentation_templates.md 800ec55dfc Make arguments redo, subproject elimination (#1784) 7 éve
eclipse.md 8e99fbc884 Fixed typo of 'confid.h' to 'config.h' (#2448) 7 éve
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section 7 éve
faq_build.md 0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337) 7 éve
faq_debug.md bb53635f33 Trim trailing whitespace 7 éve
faq_general.md 7b0356d1d4 Convert all headings to Title Case 7 éve
faq_keymap.md bfc9aa66f9 Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660) 6 éve
feature_advanced_keycodes.md d263b27c9a Dedupe shifted keycodes listing 6 éve
feature_audio.md 8ffeaec3aa Overhaul to keycode related docs 6 éve
feature_auto_shift.md 303f425c6b Fix up info boxes. 7 éve
feature_backlight.md 9b7a3a0bc8 Docs: Add Usage section to backlight docs (#3537) 6 éve
feature_bluetooth.md 4c675a83ba Format keycode tables 7 éve
feature_bootmagic.md f2ebafcee8 Docs: Make Bootmagic and Command docs a little easier to read (#3499) 6 éve
feature_command.md 25d757284c Docs: Fix Command docs escaping (#3523) 6 éve
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) 6 éve
feature_grave_esc.md 2bc34b09cd Docs: Format Grave Escape documentation (#3536) 6 éve
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) 6 éve
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) 6 éve
feature_layouts.md 2018df1a61 Clarify the format for layout names 7 éve
feature_leader_key.md 3b1ddd12a5 Refresh & improve leader documentation page (#2990) 7 éve
feature_macros.md 303f425c6b Fix up info boxes. 7 éve
feature_mouse_keys.md 7f7f763598 Fixed dead links (#2451) 7 éve
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos 7 éve
feature_ps2_mouse.md bb53635f33 Trim trailing whitespace 7 éve
feature_rgb_matrix.md 435e9b7bdb RGB Driver Documentation Update (#3601) 6 éve
feature_rgblight.md d8e6ada5d7 Improve RGB lighting documentation (#3580) 6 éve
feature_space_cadet_shift.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 éve
feature_space_cadet_shift_enter.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 éve
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace 7 éve
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) 6 éve
feature_tap_dance.md bb86d8a00c Docs: Fix some minor errors in tap dance example (#3530) 6 éve
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) 7 éve
feature_thermal_printer.md 4c675a83ba Format keycode tables 7 éve
feature_unicode.md af37bb2f78 Fix some of the more obvious typos 7 éve
feature_userspace.md e9755521ab Update README with rules.mk ordering information. 6 éve
features.md d263b27c9a Dedupe shifted keycodes listing 6 éve
flashing.md a7fca47686 Link to Atmel's flip is broken. (#2752) 7 éve
fuse.txt ca01d94005 convert docs to lowercase and underscores 8 éve
getting_started_build_tools.md 0d5a8b048a Instruct macos users to use avr-gcc@7 (#3337) 7 éve
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) 7 éve
getting_started_github.md f2fcffab0d Docs: Adjust prompt to be more recognizable (#3417) 6 éve
getting_started_introduction.md c5c112ae29 Update config.h boilerplate to use `#pragma once` 6 éve
getting_started_make_guide.md 0fab3bbde3 Lets split eh (#3120) 6 éve
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos 7 éve
hand_wire.md bb53635f33 Trim trailing whitespace 7 éve
hardware.md af37bb2f78 Fix some of the more obvious typos 7 éve
hardware_avr.md 303f425c6b Fix up info boxes. 7 éve
hardware_drivers.md 435e9b7bdb RGB Driver Documentation Update (#3601) 6 éve
hardware_keyboard_guidelines.md 9fb1e5d171 Remove bootloader key as it is no longer used (#3093) 7 éve
how_keyboards_work.md 7b0356d1d4 Convert all headings to Title Case 7 éve
index.html 7d49a17781 override hamburger placement 7 éve
internals_defines.md ae7284edb8 rename api docs to internals 7 éve
internals_input_callback_reg.md ae7284edb8 rename api docs to internals 7 éve
internals_midi_device.md ae7284edb8 rename api docs to internals 7 éve
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals 7 éve
internals_midi_util.md ae7284edb8 rename api docs to internals 7 éve
internals_send_functions.md ae7284edb8 rename api docs to internals 7 éve
internals_sysex_tools.md ae7284edb8 rename api docs to internals 7 éve
isp_flashing_guide.md ac46378ac6 Update ISP flashing guide with pre-compiled binary (#3217) 6 éve
keycode.txt bb53635f33 Trim trailing whitespace 7 éve
keycodes.md d263b27c9a Dedupe shifted keycodes listing 6 éve
keycodes_basic.md 435a1202e7 More improvements to keycode docs (#3567) 6 éve
keycodes_us_ansi_shifted.md f6ec2ce201 Update Shifted keycodes docs (#3575) 6 éve
keymap.md 07b90db897 Fixes and updates to docs (#2611) 7 éve
newbs.md c7b8e45ba1 Docs: add resources for git (#3390) 7 éve
newbs_building_firmware.md 303f425c6b Fix up info boxes. 7 éve
newbs_flashing.md 303f425c6b Fix up info boxes. 7 éve
newbs_getting_started.md 06b3637266 added some helpful notes to the documentation (#2981) 7 éve
newbs_learn_more_resources.md c7b8e45ba1 Docs: add resources for git (#3390) 7 éve
newbs_testing_debugging.md 08e48eb6f5 Add a newbie guide for people completely new to QMK (#2480) 7 éve
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md af37bb2f78 Fix some of the more obvious typos 7 éve
power.txt bb53635f33 Trim trailing whitespace 7 éve
qmk.css ccc87421e7 Some more tweaks to make everything look nice 7 éve
quantum_keycodes.md bb53635f33 Trim trailing whitespace 7 éve
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 éve
reference_glossary.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) 6 éve
sidebar.css 7d49a17781 override hamburger placement 7 éve
sw.js 303f425c6b Fix up info boxes. 7 éve
understanding_qmk.md 7f7f763598 Fixed dead links (#2451) 7 éve
unit_testing.md bb53635f33 Trim trailing whitespace 7 éve
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores 8 éve

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.