Начало Каталог Помощ
Вход
mindtravel
/
qmk_firmware_custom
разклонено от logic855/qmk_firmware
2
0
Разклонения 0
Файлове
ИН на ревизия: 6f124b7909
Клонове Маркери
qmk_firmware...
/
docs
Rob Rogers 2519de92b5 [Docs] Add udev rule for Input Club bootloaders (#5494) преди 6 години
..
gitbook 4580d3a730 RGB improvements (#1684) преди 8 години
zh 3cf179be61 Adds Proton C Conversion (#4661) преди 7 години
.nojekyll 9e5676650e Use docsfy to replace gitbook преди 7 години
CNAME 4d26137e2a Create CNAME преди 7 години
LANGS.md d5a06aec83 Second try at configuring i18n for docsify and gitbook (#4531) преди 7 години
README.md 73ddb764cc Fix readme and contributing hyperlinks преди 7 години
_summary.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) преди 6 години
arm_debugging.md ac7b2d92bf ARM SWD guide преди 7 години
becoming_a_qmk_collaborator.md 1acaf2b2c2 Tweak the wording in "Becoming a QMK Collaborator" преди 7 години
compatible_microcontrollers.md 7b0356d1d4 Convert all headings to Title Case преди 8 години
config_options.md f077204fae Add support for RGB LEDs wired directly to each half's controller (#5392) преди 6 години
contributing.md 6d4f6f3f49 [Docs] Add Tap Dance example to the docs (#5326) преди 6 години
custom_quantum_functions.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) преди 6 години
documentation_best_practices.md 303f425c6b Fix up info boxes. преди 7 години
documentation_templates.md 8454fa5e9f Update Document Templates to reflect newer wording and URLs (#4006) преди 7 години
faq.md e6c638bed1 Overhaul the Getting Started section and add a FAQ section преди 8 години
faq_build.md 2519de92b5 [Docs] Add udev rule for Input Club bootloaders (#5494) преди 6 години
faq_debug.md bb53635f33 Trim trailing whitespace преди 8 години
faq_general.md 7b0356d1d4 Convert all headings to Title Case преди 8 години
faq_keymap.md 384fef72d3 Replace instances of KEYMAP with LAYOUT преди 6 години
feature_advanced_keycodes.md 6d4f6f3f49 [Docs] Add Tap Dance example to the docs (#5326) преди 6 години
feature_audio.md 4f0dc945c3 [Docs] Add music_map to audio documentation (#5419) преди 6 години
feature_auto_shift.md 303f425c6b Fix up info boxes. преди 7 години
feature_backlight.md df251d7a13 Backlight - New option : BACKLIGHT_CAPS_LOCK (#4769) преди 6 години
feature_bluetooth.md 914d42acd0 Update Bluetooth docs (#4062) преди 7 години
feature_bootmagic.md 3a513fc3a3 [Docs] Bootmagic Lite Caveat (#5069) преди 6 години
feature_combo.md e251850cd8 added missing ; on example (#5089) преди 6 години
feature_command.md 5cb713148d Change Command keycode defaults to match corresponding Bootmagic codes (#5078) преди 6 години
feature_debounce_type.md c7c4937eef Clean up debounce a bit (#5255) преди 6 години
feature_dynamic_macros.md 6caea0acfb Docs: Adjust dynamic macro docs to include more than the planck (#3509) преди 7 години
feature_encoders.md 1e1b55fbdf Improve Encoder documentation (#5130) преди 6 години
feature_grave_esc.md 3510d8dc8d Document an annoyance with Grave Escape and macOS Terminal (#5483) преди 6 години
feature_haptic_feedback.md 2cee371bf1 Haptic feedback generalized - DRV2605 and solenoids (#4939) преди 6 години
feature_hd44780.md bbea9dadbc Integrating Peter Fleury's HD44780 LCD library (#3209) преди 7 години
feature_key_lock.md c11a26ba54 Docs: Format Key Lock documentation (#3538) преди 7 години
feature_layouts.md 40e67a3074 Add a mechanism for force building a particular community layout (#5027) преди 6 години
feature_leader_key.md afd5cda4a0 Fix up process_leader to be a bit more optimized (#4662) преди 7 години
feature_led_matrix.md 24df54b807 Add documentation for led matrix преди 6 години
feature_macros.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) преди 6 години
feature_mouse_keys.md 346cbd8816 Add 3 speed mousekey movement option (#2246) преди 6 години
feature_pointing_device.md af37bb2f78 Fix some of the more obvious typos преди 8 години
feature_ps2_mouse.md 58b9b22670 Circuitry sample for PS/2 Mouse (#3959) преди 7 години
feature_rgb_matrix.md 221ac2eabb New RGB Matrix effect: Single color reactive (#5330) преди 6 години
feature_rgblight.md f077204fae Add support for RGB LEDs wired directly to each half's controller (#5392) преди 6 години
feature_space_cadet_shift.md 5c7a31eae2 Improvements to Space Cadet Shift (#3856) преди 6 години
feature_space_cadet_shift_enter.md 03ad6927cb Docs: Format Space Cadet documentation (#3540) преди 7 години
feature_stenography.md c0baf2a964 Improve state/chord handling and clean up namespace преди 7 години
feature_swap_hands.md fd085837e1 fix swap_hands keycodes in documentation (#3588) преди 7 години
feature_tap_dance.md 6d4f6f3f49 [Docs] Add Tap Dance example to the docs (#5326) преди 6 години
feature_terminal.md 5112af887a Added command history to terminal with other bug fixes, added new song to song_list.h (#2855) преди 7 години
feature_thermal_printer.md 4c675a83ba Format keycode tables преди 8 години
feature_unicode.md 9b82a9295f [Docs] Add note about using Unicode Hex Input (#5248) преди 6 години
feature_userspace.md 3d446c6050 [Docs] Update the KC_MAKE example in Userspace docs (#5337) преди 6 години
feature_velocikey.md c1c5922aae Velocikey: Match RGB animation speed to typing speed (#3754) преди 6 години
features.md 3305df8e79 Add LED Matrix to Features list for easy reference (#5280) преди 6 години
flashing.md ab29481391 Fix link to Caterina bootloader hex files (#5452) преди 6 години
fuse.txt ca01d94005 convert docs to lowercase and underscores преди 8 години
getting_started_build_tools.md fef206f661 getting_started_build_tools: dfu-{util,programmer} now available from arch repo преди 6 години
getting_started_getting_help.md 48913153c3 Replace gitter links with Discord. (#3368) преди 7 години
getting_started_github.md 76aa2baf3e Fix doc typo преди 7 години
getting_started_introduction.md c5c112ae29 Update config.h boilerplate to use `#pragma once` преди 7 години
getting_started_make_guide.md c7c4937eef Clean up debounce a bit (#5255) преди 6 години
getting_started_vagrant.md af37bb2f78 Fix some of the more obvious typos преди 8 години
hand_wire.md 8c2a23dee1 Add more "decent" text editors (#5308) преди 6 години
hardware.md af37bb2f78 Fix some of the more obvious typos преди 8 години
hardware_avr.md fc06986989 Remove CUSTOM_MATRIX option from diode direction (#5090) преди 6 години
hardware_drivers.md fdd0f91527 ISSI31FL3733 driver (#3679) преди 7 години
hardware_keyboard_guidelines.md aeee735f35 Clarify LAYOUT vs LAYOUT_all преди 6 години
how_keyboards_work.md c02c7b7517 Fix ascii art (#5407) преди 6 години
i2c_driver.md 37932c293c Next set of split_common changes (#4974) преди 6 години
index.html 3cf179be61 Adds Proton C Conversion (#4661) преди 7 години
internals_defines.md ae7284edb8 rename api docs to internals преди 7 години
internals_gpio_control.md 3c26f07f5a Grammatical fixes for GPIO Control doc (#4869) преди 6 години
internals_input_callback_reg.md ae7284edb8 rename api docs to internals преди 7 години
internals_midi_device.md ae7284edb8 rename api docs to internals преди 7 години
internals_midi_device_setup_process.md ae7284edb8 rename api docs to internals преди 7 години
internals_midi_util.md ae7284edb8 rename api docs to internals преди 7 години
internals_send_functions.md ae7284edb8 rename api docs to internals преди 7 години
internals_sysex_tools.md ae7284edb8 rename api docs to internals преди 7 години
isp_flashing_guide.md 1dda671e4a ISP Flashing Guide - atmega32a info (#4993) преди 6 години
keycodes.md 79b58937f4 Add C(), A() and G() to match already existing S() (#4673) преди 6 години
keycodes_basic.md ba05f9667b Add new brightness aliases to keycodes_basic.md преди 6 години
keycodes_us_ansi_shifted.md 9374c0c9db Add caveats for shifted characters (#4192) преди 7 години
keymap.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) преди 6 години
newbs.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) преди 6 години
newbs_best_practices.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) преди 7 години
newbs_building_firmware.md a5b10e5da2 Fix syntax for windows преди 7 години
newbs_building_firmware_configurator.md efe360464d Contribute the MechMerlin QMK Configurator docs (#4986) преди 6 години
newbs_flashing.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) преди 6 години
newbs_getting_started.md 161d469f2c [Docs] Recursively clone qmk_firmware repo (#5378) преди 6 години
newbs_learn_more_resources.md 480651cf9d Docs: Adding QMK Git Conventions doc; formatting cleanup on Learning Resources doc (#3902) преди 7 години
newbs_testing_debugging.md 338ca3569a Add docs on using keyboard_post_init_user to enable debug modes преди 6 години
other_eclipse.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) преди 6 години
other_vscode.md e9ace14878 [Docs] Add VSCode guide to docs (#5124) преди 6 години
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md 384fef72d3 Replace instances of KEYMAP with LAYOUT преди 6 години
power.txt bb53635f33 Trim trailing whitespace преди 8 години
proton_c_conversion.md 3cf179be61 Adds Proton C Conversion (#4661) преди 7 години
qmk.css ccc87421e7 Some more tweaks to make everything look nice преди 7 години
quantum_keycodes.md 6e44f94f21 Add EEPROM_RESET keycode to core code (#4234) преди 7 години
redirects.json 03ad6927cb Docs: Format Space Cadet documentation (#3540) преди 7 години
ref_functions.md 75a51659ab Add tap_random_base64 and software timer info to Useful Functions doc (#4360) преди 7 години
reference_configurator_support.md d8f090e559 Docs: Supporting a keyboard in the QMK Configurator (#4396) преди 7 години
reference_glossary.md dad79cafcd Fix more broken links to the HID spec преди 7 години
reference_info_json.md bcb1815420 Add label to the info.json reference преди 6 години
sidebar.css 7d49a17781 override hamburger placement преди 7 години
support.md 2ad2b73d68 Add support for PR and Issue templates to QMK_firmware GitHub (#4494) преди 7 години
sw.js 303f425c6b Fix up info boxes. преди 7 години
understanding_qmk.md c534a4c775 [Docs] Smallish overhaul of the docs (#5281) преди 6 години
unit_testing.md bb53635f33 Trim trailing whitespace преди 8 години
usb_nkro.txt 995c3141a6 convert docs to lowercase and underscores преди 8 години

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.