Skip to content

Commit

Permalink
chore: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
calebdw committed Jan 10, 2024
1 parent 8d9efad commit 3d85d14
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Wireless Corne ZMK Config

My [ZMK](https://github.com/zmkfirmware/zmk) configs for my [Typeractive](https://typeractive.xyz/) Corne
using the `nice!nano` MC and `nice!view` display.


### Docker

To build using Docker, simply execute `make`. The resulting firmware can then be found under `./firmware` to be flashed to the respective side of the Corne.

Execute `make clean` to clean out the firmware files and build cache.

Execute `make distclean` to remove the docker image used to build the firmware.


### Layout

Inspiration is taken from the [Miryoku](https://github.com/manna-harbour/miryoku_zmk) layout for the split layers and the keyboard layout is slightly modified from the [Engram](https://engram.dev) layout.

0 comments on commit 3d85d14

Please sign in to comment.