Open-source keyboard firmware for Atmel AVR and Arm USB families https://qmk.fm
Go to file
Drashna Jaelre beb320a5c6 Fix Windows formatting issues
Co-Authored-By: fauxpark <fauxpark@gmail.com>
2019-08-30 15:01:52 -07:00
.github Tweak issue templates (capitalisation mostly) (#5133) 2019-02-14 20:44:27 -08:00
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
bin Make the CLI Ψ capital (#6637) 2019-08-30 10:23:36 -07:00
docs Migrate ACTION_LAYER_MOMENTARYs to MO() (#5176) 2019-08-30 15:01:52 -07:00
drivers Added OLED Display autoscroll during periods of OLED data inactivity (#6546) 2019-08-25 12:37:55 -07:00
keyboards Update swedish based keymaps with newer keycodes 2019-08-30 15:01:52 -07:00
layouts Fix Windows formatting issues 2019-08-30 15:01:52 -07:00
lib Refactor qmk compile-json to qmk compile (#6592) 2019-08-25 11:58:24 -07:00
quantum Update swedish based keymaps with newer keycodes 2019-08-30 15:01:52 -07:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Have clang ignore the code in bootloader_size.c 2019-08-30 15:01:52 -07:00
users Added OLED Display autoscroll during periods of OLED data inactivity (#6546) 2019-08-25 12:37:55 -07:00
util Add new files to the list of files that are formatted. (#6296) 2019-08-30 15:01:52 -07:00
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 2017-12-11 21:06:05 -05:00
.clang-format fix indent size 2019-06-11 01:51:40 -07:00
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes Set eep files to binary mode 2016-08-27 18:37:28 +03:00
.gitignore QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitmodules Update .gitmodules 2017-11-16 15:09:45 -05:00
.travis.yml Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
autocomplete.sh Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10:00
book.json adds redirects for docs 2017-08-19 08:31:54 -04:00
bootloader.mk Usbasploader bootloader option addition (#6304) 2019-07-15 19:11:59 -07:00
build_full_test.mk Add SRC and OPT_DEFS when building tests 2017-07-20 10:17:31 -04:00
build_json.mk Fix compiling json files. (#6340) 2019-07-15 15:12:35 -07:00
build_keyboard.mk add 'objs-size' target into tmk_core/avr.mk (#5490) 2019-07-15 22:45:31 -07:00
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08:00
build_test.mk Split common.mk into common.mk and common_features.mk 2017-06-18 21:22:22 +03:00
CODE_OF_CONDUCT.md updates the coc 2019-08-24 12:43:39 -04:00
common_features.mk Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 2019-07-09 07:57:14 -07:00
common.mk Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
Dockerfile Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
doxygen-todo Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
Makefile Add an alternative method for keyboard discovery to speed up build (#6073) 2019-08-15 22:03:26 +01:00
message.mk Add a universal flash command for cli (#6224) 2019-08-20 15:39:24 -07:00
readme.md Branch point for 2019 Aug 30 Breaking Change 2019-08-30 15:01:52 -07:00
requirements.txt QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
secrets.tar.enc update building for .hex, secrets moving 2017-08-21 21:57:46 -04:00
setup.cfg QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
shell.nix shell.nix: Downgrade gcc-arm-embedded (#5913) 2019-07-16 00:35:15 -07:00
show_options.mk Add option to enable LTO easily (#5674) 2019-05-02 08:03:42 -07:00
testlist.mk Add basic infrastrucure for building full tests 2017-06-18 21:08:23 +03:00
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 2019-07-16 01:20:34 -07:00

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

NOTICE: THIS IS A TESTING BRANCH

This is the breaking_changes branch for Aug 2019. You can read more in the tracking issue.

We encourage you to try this branch out and see if there are any bugs. Our goal is to merge this branch to master on Aug 30. Please report any bugs you find.

Original readme.md continues:

This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.

Documentation

The docs are hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

Supported Keyboards

The project also includes community support for lots of other keyboards.

Maintainers

QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.