https://github.com/itspriddle/k6-qmk

My custom QMK firmware for Keychron K6
https://github.com/itspriddle/k6-qmk

firmware keyboard keychron keychronk6 qmk qmk-firmware

Last synced: about 5 hours ago
JSON representation

My custom QMK firmware for Keychron K6

• Host: GitHub
• URL: https://github.com/itspriddle/k6-qmk
• Owner: itspriddle
• Created: 2021-08-29T23:58:27.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-13T05:21:09.000Z (almost 3 years ago)
• Last Synced: 2023-04-13T14:56:11.532Z (almost 2 years ago)
• Topics: firmware, keyboard, keychron, keychronk6, qmk, qmk-firmware
• Language: C
• Homepage:
• Size: 50.8 KB
• Stars: 18
• Watchers: 4
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Keychron K6 QMK

This repo is for me to compile [QMK][] firmware for my [Keychron K6][]

keyboard. Actually, it uses the [Sonix QMK][] fork to work on the K6's

SN32F248B chip.

It uses GitHub actions to build and upload compiled `.bin` files suitable for

flashing with [Sonix Flasher][].

I did this for two reasons:

1. I wanted a semi-reproducible environment to build firmware on in case my

   computers change.

2. I wanted an archive of the keymap code _and_ the generated firmwares. This

   way I can tag a working version on GitHub and always have a copy in case

   I break something.

## K6 Keymap

My K6 keymap is at

[`keyboards/keychron/k6/keymaps/ansi-josh/keymap.c`](./keyboards/keychron/k6/keymaps/ansi-josh/keymap.c).

It is a copy of the [`keychron/k6/rgb/ansi:ansi`][Sonix QMK K6 Keymap]

that I've tweaked a bit.

See the [releases](https://github.com/itspriddle/k6-qmk/releases) page for

tagged builds.

## GitHub Workflow

Make changes to `keymap.c` and then commit/push them to GitHub. If a build

passes, the compiled firmware will be uploaded as a build artifact. It can be

downloaded from the view build page on GitHub. These uploads will be deleted

eventually, so do not rely on being able to download them forever.

When the firmware reaches a good saving point, uploading a git tag will

trigger a build and upload the compiled firmware as a release asset. These

files stay on GitHub for the life of the project.

To see how to do this locally on macOS or Linux, see

[`.github/workflows/build.yml`](./.github/workflows/build.yml).

Huge thanks to [QMK-on-K6][] for outlining this process!

[QMK]: https://qmk.fm

[Sonix QMK]: https://github.com/SonixQMK/qmk_firmware

[Sonix QMK K6 Keymap]: https://github.com/SonixQMK/qmk_firmware/blob/96d0671481abb3b9c751a1e35b558a86c55d9d92/keyboards/keychron/k6/keymaps/ansi/keymap.c

[Sonix Flasher]: https://github.com/SonixQMK/sonix-flasher/releases/tag/v0.2.1

[QMK-on-K6]: https://github.com/CanUnesi/QMK-on-K6/blob/main/README.md

[Keychron K6]: https://www.keychron.com/products/keychron-k6-wireless-mechanical-keyboard