chore: cleanup draw script, gh actions, README, unused files

Author: minusfive

.github/workflows/deploy.yml

@@ -1,7 +1,5 @@
 name: Deploy to Pages
-
-# Can only be triggered manually
-on: workflow_dispatch
+on: workflow_dispatch # Can only be triggered manually
 
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.

.github/workflows/draw.yml

@@ -1,6 +1,4 @@
-# Simple workflow for drawing the keymap and deploying static content to GitHub Pages
 name: Draw keymap
-
 on:
   workflow_dispatch: # can be triggered manually
   push:
@@ -27,6 +25,5 @@ jobs:
       keymap_patterns: "config/corneish_zen.keymap" # path to the keymaps to parse
       config_path: "keymap-drawer/config.yaml" # config file, ignored if it doesn't exist
       output_folder: "img" # path to save produced SVGs
-      # commit_message: "Draw: ${{ github.event.head_commit.message }}"
-      amend_commit: true # whether to amend the commit or create a new one
+      commit_message: "chore(draw): keymap"
       fail_on_error: true

README.md

@@ -1,20 +1,21 @@
 # 👊 Knucklehead
 
-[![Build ZMK firmware](https://github.com/minusfive/zmk-config/actions/workflows/build.yml/badge.svg)](https://github.com/minusfive/zmk-config/actions/workflows/build.yml) [![Draw keymap](https://github.com/minusfive/zmk-config/actions/workflows/draw.yml/badge.svg)](https://github.com/minusfive/zmk-config/actions/workflows/draw.yml)
-
 Knucklehead[^1] is a mnemonic, macOS-optimized, 42 key ergonomic columnar layout for [corne-style split keyboards](https://github.com/foostan/crkbd), designed[^2] to ease the transition from standard ANSI Apple-style keyboards.
 
-> [!WARNING]\
-> [Home Row Mods](#timer-less-home-row-mods) are now the default. Previous version available on the [legacy branch](https://github.com/minusfive/zmk-config/tree/legacy).
+> [!WARNING]
 >
 > Under **_active development_**. Expect breaking changes and scarce/incomplete documentation.
 
-<img src="./img/corneish_zen.svg" alt="minusfive's keymap layout graphical representation" width="100%" />
+[![Build ZMK firmware](https://github.com/minusfive/zmk-config/actions/workflows/build.yml/badge.svg)](https://github.com/minusfive/zmk-config/actions/workflows/build.yml) [![Draw keymap](https://github.com/minusfive/zmk-config/actions/workflows/draw.yml/badge.svg)](https://github.com/minusfive/zmk-config/actions/workflows/draw.yml)
 
-![minusfive's Corne-ish Zen](img/corneish_zen.png)
+<img src="./img/corneish_zen.svg" alt="Knucklehead keymap layout graphical representation" width="100%" />
 
 > Drawn with [@caksoylar's Keymap Drawer](https://github.com/caksoylar/keymap-drawer)
 
+> [!IMPORTANT]
+>
+> [Home Row Mods](#timer-less-home-row-mods) are now the default. Previous version available on the [legacy branch](https://github.com/minusfive/zmk-config/tree/legacy).
+
 ## Legend
 
 | Symbol | Key Name                                     | Symbol | Key Name                                                  |
@@ -35,8 +36,15 @@ Knucklehead[^1] is a mnemonic, macOS-optimized, 42 key ergonomic columnar layout
 
 ### Mnemonic Affordances
 
-> [!NOTE]\
-> These are **optimized for the [Colemak-DH](https://colemakmods.github.io/mod-dh/)** layout. While many will work well regardless of layout, others will be "lost in translation".
+> [!NOTE]
+>
+> These are **optimized for the [Colemak-DH](https://colemakmods.github.io/mod-dh/)** layout (default). However, most should still work well regardless of layout, while others will be "lost in translation".
+>
+> Other layouts available:
+>
+> - [Colemak](./knucklehead/L1_colemak.dtsi) (classic)
+> - [Dvorak](./knucklehead/L1_dvorak.dtsi)
+> - [QWERTY](./knucklehead/L1_qwerty.dtsi)
 >
 > See: [Using layouts other than Colemak-DH](#using-layouts-other-than-colemak-dh)
 
@@ -91,7 +99,8 @@ Together with the [single base layer](#single-base-layer) and [upper layer swapp
 
 By using [@urob's Timer-less](https://github.com/urob/zmk-config?tab=readme-ov-file#timeless-homerow-mods) [Home Row Mods](https://precondition.github.io/home-row-mods), modifier keys (`⌃`, `⌥`, `⌘`, `▲`) can be activated by holding keys in the "home row", consistently across layers, without interfering with normal typing (i.e. without the need to tap a key within a certain time window).
 
-> [!NOTE]\
+> [!NOTE]
+>
 > To hold-repeat a key in the home row (or any other dual-purpose key), simply tap it twice and hold.
 
 ---
@@ -104,7 +113,8 @@ The most common example of this type of behavior is [ZMK's `&caps_word`](https:/
 
 This layout uses 2 smart word behaviors (marked with the 🆆 symbol):
 
-> [!NOTE]\
+> [!NOTE]
+>
 > Both of these were taken from [@urob's fantastic layout](https://github.com/urob/zmk-config).
 
 #### Smart Shift
@@ -146,7 +156,8 @@ On `L2` the same thumb keys you use to summon it will act as follows:
 
 ### Non-Stacking Upper Layers
 
-> [!NOTE]\
+> [!NOTE]
+>
 > If this all sounds like gibberish to you here's all you need to understand: `L1` should always be the layer behind `L2` or `Fn`. If that's not the case, please [report it as a bug](https://github.com/minusfive/zmk-config/issues).
 
 One of [ZMK's great features is its stacking layers model](https://zmk.dev/docs/features/keymaps#layers).
@@ -175,15 +186,6 @@ Without this behavior it might've been confusing if you pressed the `Fn` key whi
 
 ## Using layouts other than Colemak-DH
 
-> [!NOTE]\
-> Other layouts available:
->
-> - [Colemak](./knucklehead/L1_colemak.dtsi) (classic)
-> - [Dvorak](./knucklehead/L1_dvorak.dtsi)
-> - [QWERTY](./knucklehead/L1_qwerty.dtsi)
->
-> Feel free to submit [PRs](https://github.com/minusfive/zmk-config/pulls) with additional layouts, or [open an issue](https://github.com/minusfive/zmk-config/issues) if you need help with a specific layout. Of course, you're also always welcome to fork this repo and create your own custom layouts.
-
 In order to use layouts other than the default [Colemak-DH](https://colemakmods.github.io/mod-dh/) layout, you'll need to comment-out the `#include "L1_colemak-dh.dtsi"` statement in [./knucklehead/base.dtsi](./knucklehead/base.dtsi), and uncomment the corresponding layout file you wish to use. E.g.:
 
 ```diff
@@ -197,6 +199,16 @@ In order to use layouts other than the default [Colemak-DH](https://colemakmods.
 +#include "L1_qwerty.dtsi"
 ```
 
+Feel free to submit [PRs](https://github.com/minusfive/zmk-config/pulls) with additional layouts.
+
+## Drawing the Keymap
+
+This project uses [@caksoylar's Keymap Drawer](https://github.com/caksoylar/keymap-drawer) to generate the [keymap SVG](./img/corneish_zen.svg) displayed at the top of this document. It can be re-generated by running the [Draw keymap](./.github/workflows/draw.yml), or locally through the Zsh script:
+
+```zsh
+./scripts/draw.zsh
+```
+
 ---
 
 ## Resources
@@ -207,10 +219,14 @@ In order to use layouts other than the default [Colemak-DH](https://colemakmods.
 - [@caksoylar's Keymap Drawer](https://github.com/caksoylar/keymap-drawer), [ZMK config](https://github.com/caksoylar/zmk-config) and [Display improvements for Corne-ish Zen](https://gist.github.com/caksoylar/c411313990978e1903c244f03039187a)
 - [@urob's ZMK config](https://github.com/urob/zmk-config)
 - [Colemak-DH](https://colemakmods.github.io/mod-dh/) and the [Effort Grid](https://colemakmods.github.io/mod-dh/model.html)
-- [Darryl's amazing Corne-ish Zen](https://lowprokb.ca/collections/keyboards/products/corne-ish-zen)
+- [Darryl's beautiful Corne-ish Zen](https://lowprokb.ca/collections/keyboards/products/corne-ish-zen)
 
 ---
 
 [^1]: Name inspired by the [Knuckle mnemonic](https://en.wikipedia.org/wiki/Knuckle_mnemonic).
 
 [^2]: "Designed" is perhaps too strong a word. "Haphazardly and painfully iterated over dozens of permutations, gradually removing annoyances and disruptions to my flow" is too long, though.
+
+```
+
+```

img/corneish_zen.png

@@ -1,4 +1,4 @@
-layout: {qmk_keyboard: corne_rotated, qmk_layout: LAYOUT_split_3x6_3}
+layout: {zmk_keyboard: corneish_zen, layout_name: default_transform}
 layers:
   L1:
   - $$mdi:keyboard-esc$$

img/corneish_zen.yaml

@@ -0,0 +1,17 @@
+#!/usr/bin/env zsh
+
+set -euo pipefail
+
+function {
+  local __keymap="${1:-corneish_zen}"
+
+  local __repo_dir="$(dirname $(dirname $(realpath $ZSH_ARGZERO)))"
+  local __keymap_input_file="$__repo_dir/config/${__keymap}.keymap"
+  local __keymap_svg="$__repo_dir/img/${__keymap}.svg"
+  local __keymap_yaml="$__repo_dir/img/${__keymap}.yaml"
+  local __draw_config="$__repo_dir/keymap-drawer/config.yaml"
+
+  keymap -c $__draw_config parse -z $__keymap_input_file -o $__keymap_yaml
+  keymap -c $__draw_config draw $__keymap_yaml -o $__keymap_svg
+} $@
+