No description
Find a file
Drashna Jaelre 311d625c56 [Docs] Add dedicated page for Split Keyboard information (#5802)
* [Docs] Add dedicated page for Split Keyboard information

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix Typos

Co-Authored-By: drashna <drashna@live.com>

* Fix some formatting issues

* Add Additional RGB info

* Fix Bulletted formatting

* Apply suggestions from code review

Co-Authored-By: drashna <drashna@live.com>

* Fix line wrapping

* Additional fixes and expansion

* Reword warning/note

Co-Authored-By: drashna <drashna@live.com>

* add i2c/serial coexistance info

* i2c markdown

* Change i2c wiring text

Co-Authored-By: drashna <drashna@live.com>
2019-07-15 23:23:32 -07:00
.github Tweak issue templates (capitalisation mostly) (#5133) 2019-02-14 20:44:27 -08:00
.vscode
bin QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
docs [Docs] Add dedicated page for Split Keyboard information (#5802) 2019-07-15 23:23:32 -07:00
drivers Add GPL3 header to avr i2c files (#6332) 2019-07-15 10:32:13 -07:00
keyboards Remove/migrate action_get_macro()s from default keymaps (#5625) 2019-07-15 23:04:02 -07:00
layouts Remove/migrate action_get_macro()s from default keymaps (#5625) 2019-07-15 23:04:02 -07:00
lib Fix compiling json files. (#6340) 2019-07-15 15:12:35 -07:00
quantum Sendstring LUT improvements (#5727) 2019-07-15 23:15:07 -07:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Skip unsupported firmware check message in silent mode (#5765) 2019-07-15 23:21:00 -07:00
users Switching rgb_config_t to use HSV struct 2019-07-12 07:39:35 -07:00
util QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.clang-format fix indent size 2019-06-11 01:51:40 -07:00
.clang_complete
.editorconfig QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitattributes
.gitignore QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
.gitmodules
.travis.yml Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
autocomplete.sh
book.json
bootloader.mk Usbasploader bootloader option addition (#6304) 2019-07-15 19:11:59 -07:00
build_full_test.mk
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
CODE_OF_CONDUCT.md
common.mk Move Split Common VPATH addition (#4716) 2018-12-31 08:45:44 -08:00
common_features.mk Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 2019-07-09 07:57:14 -07:00
Dockerfile Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
Doxyfile
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile Make python a required build dependency (#5784) 2019-05-06 10:56:34 -07:00
message.mk Display firmware size percentage (#6307) 2019-07-11 12:05:13 -07:00
readme.md Removes Erez personally from QMK (#5883) 2019-05-15 19:53:45 -04:00
requirements.txt QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
secrets.tar.enc
setup.cfg QMK CLI and JSON keymap support (#6176) 2019-07-15 12:14:27 -07:00
shell.nix shell.nix: Packages relocated in upstream cleanup 2018-12-22 15:09:58 -08:00
show_options.mk Add option to enable LTO easily (#5674) 2019-05-02 08:03:42 -07:00
testlist.mk
Vagrantfile Update run command now that the install script is unattended, fix mount point for Debian (#5847) 2019-05-11 17:55:12 -07:00

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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.