aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..941681c
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,10 @@
+### zmk build repository
+my [zmk](https://zmk.dev) configuration & keyboard code!
+
+![keyboard](https://i.imgur.com/4kl6spPh.jpg)
+
+### misc
+* [`util.h`](util.h) contains some simple macros for combos, 2-key tap dance, & home-row mods.
+* [`build.sh`](build.sh) is a (convolute) script to build and flash firmware.\
+coincidentally, my primary zmk keyboards use an identical layout, so the necessary files can be temporarily copied over at build time
+* **layout** is near identical to my layout [here (keymapdb)](https://keymapdb.com/keymaps/waffle87), sans a couple things line unicode