No description
Find a file
Mateusz Piotrowski 189e0d5b98
Update FreeBSD install method (#12815)
The easiest way to install QMK CLI and all the necessary
dependencies on FreeBSD is to use the packages
from the official FreeBSD Ports Collection.

This is possible since QMK CLI has been added to the Ports Collection:
https://www.freshports.org/sysutils/py-qmk/
2021-05-07 19:22:05 +02:00
.github
.vscode
api_data
bin
data
docs Update FreeBSD install method (#12815) 2021-05-07 19:22:05 +02:00
drivers Fixup Satisfaction75 bootprocess. (#12621) 2021-04-19 13:08:01 +10:00
keyboards [Keymap] My Arisu layout setup (#12647) 2021-05-07 19:51:47 +10:00
layouts
lib Shim cli to new keyboard script (#12780) 2021-05-02 16:59:10 +01:00
nix
platforms/chibios
quantum Do not leak weak mods from tap dance to the interrupting keypress (#12471) 2021-04-25 13:41:37 +10:00
tests
tmk_core Add a handful of consumer/gendesk page usages (#12811) 2021-05-06 17:16:07 +01:00
users Update noroadsleft userspace and keymaps (2021-05-03) (#12796) 2021-05-03 17:31:36 -07:00
util Align drivers.txt with toolbox (#12741) 2021-04-30 02:48:34 +10:00
.clang-format
.editorconfig
.gitattributes
.gitignore Add python-version to gitignore (#12678) 2021-04-26 21:18:17 +02:00
.gitmodules
.travis.yml
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk Allow <keyboard>.h to be optional when going data driven (#12706) 2021-05-01 02:00:04 +01:00
build_layout.mk
build_test.mk
CODE_OF_CONDUCT.md
common.mk
common_features.mk
disable_features.mk
Dockerfile
Doxyfile
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile
message.mk
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt Add support for tab completion (#12411) 2021-04-14 19:00:22 -07:00
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
testlist.mk
Vagrantfile

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 powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

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.