Skip to content

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
qysp committed Jul 15, 2024
1 parent 0538a32 commit 0fbe419
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 5 deletions.
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
.PHONY: all clean_firmware clean_image clean

all:
docker build --tag zmk_keiler --file Dockerfile .
docker run --rm -it --name zmk_keiler \
docker build --tag zmk_corne --file Dockerfile .
docker run --rm -it --name zmk_corne \
-v $(PWD)/firmware:/app/firmware \
-v $(PWD)/config:/app/config:ro \
zmk_keiler
zmk_corne

clean_firmware:
rm -f firmware/*.uf2
rm -f $(PWD)/firmware/*.uf2

clean_image:
docker image rm zmk_keiler docker.io/zmkfirmware/zmk-build-arm:stable
docker image rm zmk_corne docker.io/zmkfirmware/zmk-build-arm:stable

clean:
clean_firmware
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Corne ZMK

Personal ZMK config for a [Corne](https://github.com/foostan/crkbd) variant from [Typeractive](https://github.com/typeractivexyz).

Instead of having a master keyboard half which communicates with the computer, a dongle (Seeed Xiao BLE) is used which drastically increases the battery life.

## Installation

1. Copy the settings reset firmware onto the dongle and each keyboard half, respectively.
2. Copy the actual firmware onto the left & right keyboard half and turn them on.
3. Copy the actual firmware onto the dongle.
4. If the keyboard halves do not automatically connect to the dongle, use the reset button.
Empty file added firmware/.gitkeep
Empty file.

0 comments on commit 0fbe419

Please sign in to comment.