From ed446824d8f3d48677ac90ab5179e1d39e31d824 Mon Sep 17 00:00:00 2001 From: Nick Coutsos Date: Mon, 6 Jun 2022 19:02:02 -0400 Subject: New features and screenshots --- README.md | 29 +++++++++++++++++++++-------- editor-screenshot-combos.png | Bin 0 -> 173048 bytes editor-screenshot-darkmode.png | Bin 0 -> 235047 bytes editor-screenshot-macros.png | Bin 0 -> 220746 bytes editor-screenshot.png | Bin 191473 -> 220791 bytes 5 files changed, 21 insertions(+), 8 deletions(-) create mode 100644 editor-screenshot-combos.png create mode 100644 editor-screenshot-darkmode.png create mode 100644 editor-screenshot-macros.png diff --git a/README.md b/README.md index 6fd7231..debb01b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Keymap Editor -A browser app (plus NodeJS server) to edit ZMK keymaps. This is still in its -infancy and doesn't yet support parsing existing ZMK keymaps which limits some -kinds of functionality (mainly those involving custom/configured behaviours). +A browser app (plus NodeJS server) to edit ZMK keymaps. This has been a solo +project but in a workable state for quite a while now, and new features are in +development all the time. **Try it live!** Go to the [keymap-editor] and try it out with the built-in [zmk-config-corne-demo] before setting up your own repo. @@ -24,10 +24,19 @@ kinds of functionality (mainly those involving custom/configured behaviours). firmware, the editor will now display the most recent build result and provide a link to the results in GitHub. It also gets `workflow_run` events in real- time so you can get live progress from within the editor. - * It's worth noting that at the time of this writing I had just finished the - work on this feature a few hours ago. It gets the latest workflow run for - the selected branch assuming that you only have one workflow defined for - your zmk-config repo. +* **\[NEW\]** [Combo editing](./editor-screenshot-combos.png) + * Fairly recent development. This allows you to assign a key bind and select + input keys visually using a scaled down mapping of the keymap layout. + * Supports further configuration of the `timeout`, `slow-release`, and + `layers` properties. +* **\[NEW\]** [Macro editing](./editor-screenshot-macros.png) + * Still in beta, but this feature enables editing macros defined in your + `.keymap` file (as well as creating new ones of course) and assigning them + as custom behaviours in your keymap. + * Will eventually support reading macros from included `.dtsi` files. +* **\[NEW\]** [Dark mode!](./editor-screenshot-darkmode.png) + * Not really my thing but it seems important to people. + * Set the theme manually or let your OS/browser set the default. ### In Progress @@ -42,7 +51,11 @@ gear icon in the top right and check the box to enable devicetree parsing. ### Planned features -* **Combo editing** -- this is the highest priority for me +* **Devicetree parsing** -- this is kind of the default but it needs refinement +* **Upstream repos** -- this will make it possible to edit keymaps for keyboards + defined in remote repositories (such as the core ZMK repo). Once this is in + place the automatic layout generation will Just Work for most people... or at + least enough to get started with the editor. * **Rotary encoders**, but I don't have a plan for a clean UI design * **Behaviour configuration** to make things like homerow mods possible diff --git a/editor-screenshot-combos.png b/editor-screenshot-combos.png new file mode 100644 index 0000000..ebd275b Binary files /dev/null and b/editor-screenshot-combos.png differ diff --git a/editor-screenshot-darkmode.png b/editor-screenshot-darkmode.png new file mode 100644 index 0000000..5b2e348 Binary files /dev/null and b/editor-screenshot-darkmode.png differ diff --git a/editor-screenshot-macros.png b/editor-screenshot-macros.png new file mode 100644 index 0000000..bb4677c Binary files /dev/null and b/editor-screenshot-macros.png differ diff --git a/editor-screenshot.png b/editor-screenshot.png index 42d8470..722cf25 100644 Binary files a/editor-screenshot.png and b/editor-screenshot.png differ -- cgit v1.2.3