mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-12-24 18:25:01 +06:00

Open-source keyboard firmware for Atmel AVR and Arm USB families

Go to file

noroadsleft eccfb8d55e SixKeyBoard refactor (#3193 ) * Refactor: create matrix macro * Readme changes * Configurator support		2018-06-16 08:02:11 -07:00
.vscode	Xton's first keymap! (#2941 )	2018-05-12 08:52:11 -07:00
docs	Add rgblight mode 35 (R,G,B test mode) (#3114 )	2018-06-04 08:10:39 -07:00
drivers	Rgb matrix fixes, I2C library can now retry if it has failed (#2943 )	2018-05-14 10:17:24 -04:00
keyboards	SixKeyBoard refactor (#3193 )	2018-06-16 08:02:11 -07:00
layouts	Ergodox EZ refactor (#3171 )	2018-06-12 21:55:08 -07:00
lib	gcc 8.10 compilation fix (#2914 )	2018-05-09 23:39:46 -04:00
quantum	fix issue with rgbinit unused variable (#3165 )	2018-06-12 17:32:56 -07:00
tests	add tests for action_layer.c and reset layer state after tests	2017-12-15 13:23:30 -05:00
tmk_core	Bootloader make issue (#2975 )	2018-06-06 18:24:26 -04:00
users	Keyboard that works on Qwerty or Bepo OS keyboards. (#3149 )	2018-06-08 10:06:25 -07:00
util	Support both AVR and ps2avrGB targets for new_project script (#2811 )	2018-05-10 00:36:40 -04:00
.clang_complete	Vim Layout for Ergodox-EZ (mac only) (#2112 )	2017-12-11 21:06:05 -05:00
.editorconfig	Fix .editorconfig to not mess with line endings	2018-02-03 15:20:44 -05:00
.gitattributes
.gitignore	Ajp10304 (#2719 )	2018-04-15 09:48:19 -07:00
.gitmodules	Update .gitmodules	2017-11-16 15:09:45 -05:00
.travis.yml	Generate API docs from source code comments (#2491 )	2018-03-22 02:50:38 -04:00
autocomplete.sh	Make arguments redo, subproject elimination (#1784 )	2017-10-14 11:32:19 -10:00
book.json
bootloader.mk	Add Teensy ++ 2.0 bootloader support	2018-05-08 20:08:17 -04:00
build_full_test.mk
build_keyboard.mk	Import userspace config.h according to USER_NAME (#2983 )	2018-05-22 12:47:28 -07:00
build_layout.mk	Creates a layouts/ folder for keymaps shared between keyboards (#1609 )	2017-08-23 22:29:07 -04:00
build_test.mk
CODE_OF_CONDUCT.md
common_features.mk	Rgb matrix fixes, I2C library can now retry if it has failed (#2943 )	2018-05-14 10:17:24 -04:00
common.mk
Dockerfile
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
license_GPLv3.md
license_Modified_BSD.md
Makefile	Added a clean target to remove build artifacts	2018-03-16 16:44:22 -04:00
message.mk	Reset color after submodule warning message	2018-01-12 13:25:05 -05:00
readme.md	add discord link	2018-05-03 15:56:10 -04:00
secrets.tar.enc	update building for .hex, secrets moving	2017-08-21 21:57:46 -04:00
shell.nix	shell.nix: add teensy loader	2017-11-26 17:55:24 -05:00
testlist.mk
Vagrantfile

readme.md

Quantum Mechanical Keyboard Firmware

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

See the official documentation on docs.qmk.fm

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 Erez Zukerman, and the Clueboard by Zach White.

Official website

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