Open-source keyboard firmware for Atmel AVR and Arm USB families https://qmk.fm

Go to file

Josh Hinnebusch 61ce41ae13 [Keyboard] Update hineybush keyboard projects (#5554 ) * Add H87a keymap and info * Create readme.md * Add h87a .json for kbfirmware.com use * Update readme.md * Update readme.md * Update h87a files * Delete Makefile * Update readme.md * Delete desktop.ini * update files to match new QMK framework * Update files to match new QMK structure * Update files to match new QMK structure * add layout name information * Add info.json * update keymap to support layout_all * update keymap to support layout_all * update rules.mk to fix filesize * Update readme.md * Update config.h * Update readme.md * Update config.h * Update config.h Add "define CONFIG_H and include "config_common.h" back to file * update config.h to include RGB turnoff when PC goes to sleep * update info.json * update info.json * Update readme.md Add project link * Update readme.md * refactor hineybush projects into single folder. update hineyg80 to modern code * updated layout file to reflect new keymap changes * actually updated all layout names this time, verified make * Update keyboards/hineybush/h87a/h87a.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/default/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/readme.md Co-Authored-By: hineybush <josh@hinnebus.ch> * edit based on PR edit requests * update hiney80 files to avoid confusion * update hineyg80.h to reflect matrix * Update keyboards/hineybush/hineyg80/info.json Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/info.json Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/info.json Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/info.json Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/default/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/keymaps/wkl/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/default/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/readme.md Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/readme.md Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/readme.md Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/readme.md Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/default/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/keymaps/default/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/readme.md Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/readme.md Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * update hineyg80 config.h * Update keyboards/hineybush/h87a/keymaps/wkl/keymap.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/keymap.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/keymap.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/keymap.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/keymap.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/keymap.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/keymap.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/h87a/keymaps/wkl/keymap.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/hineyg80.c Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/config.h Co-Authored-By: hineybush <josh@hinnebus.ch> * Update keyboards/hineybush/hineyg80/config.h Co-Authored-By: hineybush <josh@hinnebus.ch>		2019-04-30 22:35:49 -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
docs	Added OLED Driver to the summary	2019-04-30 18:04:11 -07:00
drivers	Removed / replaced questionable logos and added licenses file for safe logos	2019-04-20 08:05:10 -07:00
keyboards	[Keyboard] Update hineybush keyboard projects (#5554 )	2019-04-30 22:35:49 -07:00
layouts	Updated rgb_led struct field modifier to flags (#5619 )	2019-04-29 15:18:50 -07:00
lib	Removed forced in lining for lib8tion functions (#5670 )	2019-04-29 17:45:42 -07:00
quantum	Implement kb function for rgb matrix to led lookup (#5738 )	2019-04-30 07:55:53 -07:00
tests	Remove empty action_function()	2019-01-11 18:32:43 -08:00
tmk_core	Updated rgb_led struct field modifier to flags (#5619 )	2019-04-29 15:18:50 -07:00
users	[Keymap] Xulkal keymap tweeks (#5746 )	2019-04-30 20:55:01 -07:00
util	A better new_project.sh (#5191 )	2019-04-27 16:42:16 -07:00
.clang_complete	Vim Layout for Ergodox-EZ (mac only) (#2112 )	2017-12-11 21:06:05 -05:00
.clang-format	convert to unix line-endings [skip ci]	2019-04-18 23:23:52 +00:00
.editorconfig	Update our style guide (#5500 )	2019-04-18 15:59:51 -07:00
.gitattributes	Set eep files to binary mode	2016-08-27 18:37:28 +03:00
.gitignore	Ignore VSCode ipsh folder (#5741 )	2019-04-30 09:18:11 -07:00
.gitmodules	Update .gitmodules	2017-11-16 15:09:45 -05:00
.travis.yml	Travis CI - skip unit tests for documentation changes (#5267 )	2019-04-19 13:20:02 -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	Add Teensy ++ 2.0 bootloader support	2018-05-08 20:08:17 -04:00
build_full_test.mk	Add SRC and OPT_DEFS when building tests	2017-07-20 10:17:31 -04:00
build_keyboard.mk	Change split_common to use RGBLIGHT_SPLIT (#5509 )	2019-04-19 15:25:08 -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	Update CODE_OF_CONDUCT.md	2018-08-01 15:20:02 -04:00
common_features.mk	Simple extended space cadet (#5277 )	2019-04-29 20:21:46 -07:00
common.mk	Move Split Common VPATH addition (#4716 )	2018-12-31 08:45:44 -08:00
Dockerfile	Revert "Update build instructions and docker file to download submodules" (#5533 )	2019-04-10 14:15:51 -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	Shallow clone submodules. (#5279 )	2019-03-08 07:58:40 -08:00
message.mk	build size-check enhancement (#5485 )	2019-03-27 08:51:56 -07:00
readme.md	[Docs] Use HTTPS for qmk.fm link (#5506 )	2019-04-30 21:54:52 -07:00
secrets.tar.enc	update building for .hex, secrets moving	2017-08-21 21:57:46 -04:00
shell.nix	shell.nix: Packages relocated in upstream cleanup	2018-12-22 15:09:58 -08:00
show_options.mk	Clean up debounce a bit (#5255 )	2019-03-04 07:44:46 -08:00
testlist.mk	Add basic infrastrucure for building full tests	2017-06-18 21:08:23 +03:00
Vagrantfile	Align docker and vagrant base images (#4905 )	2019-03-17 10:36:59 -07: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

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