No description

Find a file

Michael F. Lamb c63d9ee0d5 mitosis: minor readme improvements (#3762 ) * minor improvements to top-level mitosis keyboard readme * typo * trivial readme change		2018-08-26 12:00:22 -07:00
.vscode	Xton's first keymap! (#2941 )	2018-05-12 08:52:11 -07:00
docs	Helpful functions	2018-08-26 07:32:15 -07:00
drivers	Rgb matrix arm (#3648 )	2018-08-15 01:19:38 -04:00
keyboards	mitosis: minor readme improvements (#3762 )	2018-08-26 12:00:22 -07:00
layouts	Keymap: Made changes to buswerks ortho_4x12 keymap (#3757 )	2018-08-26 09:33:43 -07:00
lib	gcc 8.10 compilation fix (#2914 )	2018-05-09 23:39:46 -04:00
quantum	Add a belgian keymap, partially based on keymap_french.h (#3737 )	2018-08-25 08:45:42 -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	Tidy up keycode.h (#3666 )	2018-08-16 12:12:48 -04:00
users	Keymap: fix conditionals in userspace rules.mk (#3726 )	2018-08-22 20:16:49 -07:00
util	Fix Typos in echo	2018-08-11 13:18:36 -07: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	Comment and organize build_keyboard.mk a bit	2018-08-11 15:19:08 -04: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	Update CODE_OF_CONDUCT.md	2018-08-01 15:20:02 -04:00
common.mk	Lets split eh (#3120 )	2018-07-16 22:25:02 -04:00
common_features.mk	Lets split eh (#3120 )	2018-07-16 22:25:02 -04:00
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	Correct parsing of rules.mk for keyboard revisions	2018-07-17 00:10:42 -04:00
message.mk	change messege at 'check-size' target	2018-08-16 12:04:35 -04:00
readme.md	Add Atreus as an official board.	2018-08-16 12:01:34 -04:00
secrets.tar.enc	update building for .hex, secrets moving	2017-08-21 21:57:46 -04:00
shell.nix	allow building with nix on darwin	2018-07-15 13:58:50 -04:00
testlist.mk
Vagrantfile	removed unused boxes (qmk won't compile with them anyway), updated welcome message	2018-06-28 22:09:38 -04:00

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, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

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.