vial-qmk/readme.md
TheWanderingCrow 428e46d8d4
Some checks are pending
CI / Check Vial UIDs (push) Waiting to run
CI / Build default keymaps for Vial (push) Waiting to run
CI / Build Vial keymaps (push) Waiting to run
docs: update readme.md
2025-11-18 11:12:28 -05:00

2.4 KiB

Quantum Mechanical Keyboard Firmware

Current Version 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 VitePress. 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.

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.

Crow-diff notes

Apply upstream changes

  1. git remote add upstream https://github.com/vial-kb/vial-qmk
  2. git checkout vial
  3. git fetch upstream
  4. git rebase crow-diffs