aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorNick Coutsos <[email protected]>2023-02-11 21:52:53 -0500
committerGitHub <[email protected]>2023-02-11 21:52:53 -0500
commit0e23d634ea4984d9a5ab7da2c2791af66f5dcb18 (patch)
tree720828f937e0a01d865f5b715bd676ae57716f84
parent2996e2ff7e2e788214be433d450a27ba6d7c7cd4 (diff)
downloadkeymap-editor-0e23d634ea4984d9a5ab7da2c2791af66f5dcb18.tar.gz
keymap-editor-0e23d634ea4984d9a5ab7da2c2791af66f5dcb18.zip
Catching up on some features listed in the readme
-rw-r--r--README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/README.md b/README.md
index af9c27b..566116b 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,9 @@ development all the time.
* [Macro editing](./screenshots/editor-screenshot-macros.png)
* [Dark mode!](./screenshots/editor-screenshot-darkmode.png)
* Support for custom behaviour definitions
+* Automatic layout generation for most keyboards available in the ZMK repo
* Rotary encoders
+* Multiple keymaps
_Read more: [Wiki:Features]_
@@ -31,12 +33,10 @@ recognize (for example, combos and custom configured behaviours).
### Planned features
-* **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.
-* **Behaviour configuration** to make things like homerow mods possible
+* **Devicetree parsing** -- keymap changes are made directly to your existing
+ `<keyboard>.keymap` file so that your keymap is readable and ready for manual
+ adjustment should the need arise.
+* **Behaviour configuration** (currently in limited beta)
* **Keymap diagram export** I'd like to be able to reference keymap diagrams in
the repository's `README.md` and have the editor update those diagrams upon
comitting the changes. I'm searching for efficient ways to reuse the React
@@ -94,4 +94,4 @@ license as well.
[zmk-config-corne-demo]: https://github.com/nickcoutsos/zmk-config-corne-demo
[zmk-config-corne-demo template]: https://github.com/nickcoutsos/zmk-config-corne-demo/generate
[Wiki:Automatic Layout Generation]: https://github.com/nickcoutsos/keymap-editor/wiki/Defining-keyboard-layouts#automatic-layout-generation
-[Wiki:Features]: https://github.com/nickcoutsos/keymap-editor/wiki/Features \ No newline at end of file
+[Wiki:Features]: https://github.com/nickcoutsos/keymap-editor/wiki/Features