https://github.com/dnlbauer/corax-zmk-config

https://github.com/dnlbauer/corax-zmk-config

Last synced: 11 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dnlbauer/corax-zmk-config
• Owner: dnlbauer
• License: mit
• Created: 2023-07-24T09:38:17.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-05-26T04:42:48.000Z (about 1 year ago)
• Last Synced: 2025-07-14T16:40:57.457Z (11 months ago)
• Size: 101 KB
• Stars: 1
• Watchers: 1
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![.github/workflows/build.yaml](https://github.com/dnlbauer/corax-zmk-config/actions/workflows/build.yaml/badge.svg)](https://github.com/dnlbauer/corax-zmk-config/actions/workflows/build.yaml)

# Firmware configuration for the Corax keyboard

This is my personal [ZMK](https://zmk.dev/) firmware configuration for the [Corax](https://github.com/dnlbauer/corax-keyboard).

The keymap optimised for US international.

It supports [ZMK Studio](https://zmk.studio/).

## Using this Config as a template

You can use this configuration on your own Corax keyboard

or use it as a base to create your own configuration with a custom

keymap:

1. Fork this repository

2. Make sure the `config/west.yaml` contains a reference to the [zmk-keyboards-corax](https://github.com/dnlbauer/zmk-keyboards-corax) module

```yaml

manifest:

  remotes:

    - name: zmkfirmware

      url-base: https://github.com/zmkfirmware

    - name: dnlbauer

      url-base: https://github.com/dnlbauer

  projects:

    - name: zmk

      import: app/west.yml

      remote: zmkfirmware

      revision: main

    - name: zmk-keyboards-corax

      remote: dnlbauer

      revision: main

  self:

    path: config

```

3. Customize the keymap in `config/corax.keymap`

4. Commit and push. Github Actions will build the firmware for you

5. Download the firmware artifact and copy it onto your keyboard (see [zmk user setup](https://zmk.dev/docs/user-setup)).

## Corax56 vs Corax54

The Corax56 and Corax54 use the same shield.

The hardware of both keyboards is identical except the Corax54 is missing one hardware key.

Therefore, you can use the same ZMK firmware for both versions of the corax.

If you have a Corax54, just set the outer pinky key to `&none`

(basically, you can set it to whatever you want. It will be ignored).

## License

MIT License