aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2024-11-06 20:42:08 +0100
committertv <tv@krebsco.de>2024-11-06 20:44:37 +0100
commite9db5e27f14017321a6df8f71f5ef7abbe358e90 (patch)
treea17f5666dc3582d21d86b2175ab7c7fd2d4b0a99 /README.md
parent594dcfb9bc6085c5c328c1a801b27f7352af612f (diff)
readme: initHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..690769f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+This repository contains a ZMK configuration for a
+[hanck_duo](https://cgit.ni.krebsco.de/hanck/) using
+[lilyinstarlight](https://github.com/lilyinstarlight)'s
+[zmk-nix](https://github.com/lilyinstarlight/zmk-nix) build system.
+
+To flash your keyboard with this configuration, call
+
+ nix run .#flash