/vial-qmk

Primary LanguageCGNU General Public License v2.0GPL-2.0

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 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.

Cyboard Dactyls

  • Keyboard Maintainer: Cyboard
  • Hardware Supported: Cyboard Dactyls with USB Type C Split Interconnect
  • Hardware Availability: cyboard.digital

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

Building Firmware

Various sizes and thumb-cluster styles are supported as keymaps. To build the firmware, use the command: qmk compile -kb cyboard/dactyl -km {THUMB STYLE}_{ROWS} where {THUMB STYLE} can be manuform, dual_arcs, or single_arc and {ROWS} can be function_row, number_row, or letters_only

Flashing

To flash the firmware to your Cyboard,

  1. Enter the bootloader by double-tapping the reset button on the back of the board.
  2. A USB device called RPI-RP2 should appear on your computer.
  3. Drag the .uf2 firmware file into RPI-RP2. RPI-RP2 should now disappear.
  4. Repeat steps 1-3 on the other half. Your Cyboard is ready to use with your new firmware!

Personally,

  1. Enter su mode
  2. Run flash script
  3. Enter bootloader
  4. ???
  5. Profit