QMK/readme.md

3.9 KiB

Quantum Mechanical Keyboard Firmware

This is a fork of the official GitHub Repo of QMK. This repo only contains userspace for my layouts and the layouts themselves.

Boards

The repo only contains keymaps for my own boards. The keymaps can be changed to other layouts as well.

Current

Incoming

Keymaps

All my keymaps are based on the userspace from Drashna. This is probably the most advanced userspace I've seen and I have heavily borrowed from it (read: copy/paste).

Keyboard-layout-editor

All the boards should be available on keyboard-layout-editor.com.

Official QMK Information

Below is information about the official GitHub Repo

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.

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.