Create basic readme with keymap SVG

kucera-lukas · Jan 1, 2025 · 8de11d3 · 8de11d3
1 parent df856d1
commit 8de11d3
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# zmk-config
+
+[![Build adv360pro](https://github.com/kucera-lukas/zmk-config/actions/workflows/build-adv360pro.yml/badge.svg)](https://github.com/kucera-lukas/zmk-config/actions/workflows/build-adv360pro.yml)
+[![Draw ZMK keymaps](https://github.com/kucera-lukas/zmk-config/actions/workflows/draw-keymaps.yml/badge.svg)](https://github.com/kucera-lukas/zmk-config/actions/workflows/draw-keymaps.yml)
+
+Personal ZMK firmware configuration
+
+> [!WARNING]\
+> Documentation is incomplete and will be improved in https://github.com/kucera-lukas/zmk-config/issues/20.
+
+## Keymap
+
+![keymap-adv360pro](./keymap-drawer/adv360pro.svg)