Files
zmk-keyboards-corax/README.md

1.3 KiB

ZMK Module: Corax Keyboard

This repository contains shield files for the Corax Keyboard. It can be used to build the zmk firmware for the keyboard.

Example user config: For a usage example, see my Corax keyboard configuration

Supported Keyboards:

Supports the Corax56 and Corax54 keyboard variants.

Hardware: Corax Keyboard Repository

Usage

Edit your west.yaml file found in your zmk config's config directory to add the corax module.

Example:

manifest:
  remotes:
    - name: dnlbauer
      url-base: https://github.com/dnlbauer
    - name: zmkfirmware
      url-base: https://github.com/zmkfirmware
  projects:
    - name: zmk
      remote: zmkfirmware
      revision: main
      import: app/west.yml
    - name: zmk-keyboards-corax
      remote: dnlbauer
      revision: main
  self:
    path: config

More Info

For more info on modules, you can read through through the Zephyr modules page and ZMK's page on using modules. Zephyr's west manifest page may also be of use.