diff --git a/Makefile b/Makefile index aa5c4c4..f4b1384 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/README.md b/README.md new file mode 100644 index 0000000..41979d4 --- /dev/null +++ b/README.md @@ -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. diff --git a/firmware/.gitkeep b/firmware/.gitkeep new file mode 100644 index 0000000..e69de29