Switch branches/tags
Find file History
LukMas and drashna Circuitry sample for PS/2 Mouse (#3959)
Added a sample circuitry for handling the connection of a PS/2 Mouse.
    Even if it's written that a circuitry is needed, there're a lot of other
    things and the information gets lost really fast. A really simple sample
    helps to remember who wants to implement the functionality about the
    circuitry.
Latest commit 58b9b22 Sep 24, 2018
Permalink
..
Failed to load latest commit information.
gitbook/images RGB improvements (#1684) Sep 6, 2017
.nojekyll Use docsfy to replace gitbook May 8, 2018
CNAME Create CNAME May 21, 2018
README.md Fix readme and contributing hyperlinks May 24, 2018
_sidebar.md Helpful functions Aug 26, 2018
_summary.md Helpful functions Aug 26, 2018
becoming_a_qmk_collaborator.md Tweak the wording in "Becoming a QMK Collaborator" Aug 30, 2018
compatible_microcontrollers.md Convert all headings to Title Case Dec 9, 2017
config_options.md Make `PREVENT_STUCK_MODIFIERS` the default (#3107) Sep 17, 2018
contributing.md docs/contributing: add `#pragma once` to Coding Conventions Sep 15, 2018
custom_quantum_functions.md Replace gitter links with Discord. (#3368) Jul 11, 2018
documentation_best_practices.md Fix up info boxes. May 8, 2018
documentation_templates.md Make arguments redo, subproject elimination (#1784) Oct 14, 2017
eclipse.md Fixed typo of 'confid.h' to 'config.h' (#2448) Feb 28, 2018
faq.md Overhaul the Getting Started section and add a FAQ section Aug 16, 2017
faq_build.md Instruct macos users to use avr-gcc@7 (#3337) Jul 8, 2018
faq_debug.md Trim trailing whitespace Dec 9, 2017
faq_general.md Convert all headings to Title Case Dec 9, 2017
faq_keymap.md Docs: Update image in FAQ/Keymap: KC_EQLS -> KC_EQL (#3660) Aug 15, 2018
feature_advanced_keycodes.md Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycod… Aug 30, 2018
feature_audio.md Overhaul to keycode related docs Jul 15, 2018
feature_auto_shift.md Fix up info boxes. May 8, 2018
feature_backlight.md Helpful functions Aug 26, 2018
feature_bluetooth.md Format keycode tables Dec 9, 2017
feature_bootmagic.md Create AG_TOGG code to toggle Alt/Gui swap. Sep 17, 2018
feature_command.md Docs: Fix Command docs escaping (#3523) Jul 30, 2018
feature_dynamic_macros.md Docs: Adjust dynamic macro docs to include more than the planck (#3509) Jul 29, 2018
feature_grave_esc.md Docs: Format Grave Escape documentation (#3536) Aug 1, 2018
feature_hd44780.md Integrating Peter Fleury's HD44780 LCD library (#3209) Jul 15, 2018
feature_key_lock.md Docs: Format Key Lock documentation (#3538) Aug 1, 2018
feature_layouts.md Docs: Add docs for the `LAYOUT_*` macro to layouts (#3772) Aug 29, 2018
feature_leader_key.md Fix LEADER_KEY docs. Sep 17, 2018
feature_macros.md Fix up info boxes. May 8, 2018
feature_mouse_keys.md Fixed dead links (#2451) Mar 1, 2018
feature_pointing_device.md Fix some of the more obvious typos Dec 9, 2017
feature_ps2_mouse.md Circuitry sample for PS/2 Mouse (#3959) Sep 23, 2018
feature_rgb_matrix.md ISSI31FL3733 driver (#3679) Aug 28, 2018
feature_rgblight.md rgblight.[ch] more configurable (#3582) Sep 13, 2018
feature_space_cadet_shift.md Docs: Format Space Cadet documentation (#3540) Aug 1, 2018
feature_space_cadet_shift_enter.md Docs: Format Space Cadet documentation (#3540) Aug 1, 2018
feature_stenography.md Improve state/chord handling and clean up namespace Apr 7, 2018
feature_swap_hands.md fix swap_hands keycodes in documentation (#3588) Aug 7, 2018
feature_tap_dance.md Docs: Fix some minor errors in tap dance example (#3530) Aug 1, 2018
feature_terminal.md Added command history to terminal with other bug fixes, added new son… May 1, 2018
feature_thermal_printer.md Format keycode tables Dec 9, 2017
feature_unicode.md Fix some of the more obvious typos Dec 9, 2017
feature_userspace.md Update README with rules.mk ordering information. Jul 17, 2018
features.md Dedupe shifted keycodes listing Aug 11, 2018
flashing.md Link to Atmel's flip is broken. (#2752) Apr 19, 2018
fuse.txt convert docs to lowercase and underscores Jun 10, 2017
getting_started_build_tools.md Instruct macos users to use avr-gcc@7 (#3337) Jul 8, 2018
getting_started_getting_help.md Replace gitter links with Discord. (#3368) Jul 11, 2018
getting_started_github.md Docs: Adjust prompt to be more recognizable (#3417) Jul 16, 2018
getting_started_introduction.md Update config.h boilerplate to use `#pragma once` Jul 15, 2018
getting_started_make_guide.md Lets split eh (#3120) Jul 17, 2018
getting_started_vagrant.md Fix some of the more obvious typos Dec 9, 2017
hand_wire.md Trim trailing whitespace Dec 9, 2017
hardware.md Fix some of the more obvious typos Dec 9, 2017
hardware_avr.md Fix up info boxes. May 8, 2018
hardware_drivers.md ISSI31FL3733 driver (#3679) Aug 28, 2018
hardware_keyboard_guidelines.md Remove bootloader key as it is no longer used (#3093) Jun 1, 2018
how_keyboards_work.md Convert all headings to Title Case Dec 9, 2017
index.html override hamburger placement May 14, 2018
internals_defines.md rename api docs to internals Mar 26, 2018
internals_input_callback_reg.md rename api docs to internals Mar 26, 2018
internals_midi_device.md rename api docs to internals Mar 26, 2018
internals_midi_device_setup_process.md rename api docs to internals Mar 26, 2018
internals_midi_util.md rename api docs to internals Mar 26, 2018
internals_send_functions.md rename api docs to internals Mar 26, 2018
internals_sysex_tools.md rename api docs to internals Mar 26, 2018
isp_flashing_guide.md Update ISP flashing guide with pre-compiled binary (#3217) Aug 3, 2018
keycode.txt Trim trailing whitespace Dec 9, 2017
keycodes.md Create AG_TOGG code to toggle Alt/Gui swap. Sep 17, 2018
keycodes_basic.md More improvements to keycode docs (#3567) Aug 4, 2018
keycodes_us_ansi_shifted.md Update Shifted keycodes docs (#3575) Aug 5, 2018
keymap.md Remove redefinition of `_______` in documentation example (#3924) Sep 19, 2018
newbs.md Docs: add resources for git (#3390) Jul 13, 2018
newbs_building_firmware.md Add an easy way to create new keymaps for your favorite keyboard (#3868) Sep 13, 2018
newbs_flashing.md Fix up info boxes. May 8, 2018
newbs_getting_started.md added some helpful notes to the documentation (#2981) May 22, 2018
newbs_learn_more_resources.md Docs: add resources for git (#3390) Jul 13, 2018
newbs_testing_debugging.md Add a newbie guide for people completely new to QMK (#2480) Mar 6, 2018
porting_your_keyboard_to_qmk_(arm_and_other_chibios_cpus).md Fix some of the more obvious typos Dec 9, 2017
power.txt Trim trailing whitespace Dec 9, 2017
qmk.css Some more tweaks to make everything look nice May 8, 2018
quantum_keycodes.md Trim trailing whitespace Dec 9, 2017
redirects.json Docs: Format Space Cadet documentation (#3540) Aug 1, 2018
ref_functions.md Helpful functions Aug 26, 2018
reference_glossary.md Docs: Format Space Cadet documentation (#3540) Aug 1, 2018
sidebar.css override hamburger placement May 14, 2018
sw.js Fix up info boxes. May 8, 2018
understanding_qmk.md Make `PREVENT_STUCK_MODIFIERS` the default (#3107) Sep 17, 2018
unit_testing.md Trim trailing whitespace Dec 9, 2017
usb_nkro.txt convert docs to lowercase and underscores Jun 10, 2017

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.