From 9438bfb0d9836d2214bf6d949c0b3601604fe348 Mon Sep 17 00:00:00 2001 From: afiqzudinhadi Date: Wed, 24 Jun 2026 16:40:39 +0800 Subject: [PATCH] Update README: mark as dropped, add confirmed flash numbers --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c6e55fe..aa300e3 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,18 @@ ZMK module that integrates the [Javelin steno engine](https://github.com/jthlim/ ## Status -Work in progress. Engine compiles and initializes. Dictionary auto-downloads and compiles during build. Requires sufficient flash for the compiled dictionary (~3-4MB for full Plover/Lapwing). Currently focused on nRF52840 boards with 1MB flash (nice_nano_v2). Not yet tested on boards with more flash or external QSPI. +Dropped — my hardware (nice_nano_v2, 1MB flash) can't fit any dictionary. Build passes on boards with sufficient flash but has not been hardware tested. Contributions welcome. -## Requirements +## Flash Requirements -- ZMK v0.3.0 -- nRF52840-based board (nice_nano_v2, etc.) -- Split keyboard: steno runs on central half only +Total flash usage (firmware + engine + dict) on a corne split (central half): + +| Dictionary | Total flash | +|------------|------------| +| Plover + Lapwing | 3.78 MB | +| Plover only | 2.53 MB | +| Lapwing only | 2.08 MB | +| No dict (engine only) | 534 KB | ## Setup @@ -38,11 +43,14 @@ Add to your `.conf`: ```ini CONFIG_ZMK_JAVELIN_STENO=y CONFIG_ZMK_JAVELIN_STENO_DICT_PLOVER=y +CONFIG_ZMK_JAVELIN_STENO_DICT_LAPWING=y CONFIG_CPLUSPLUS=y CONFIG_LIB_CPLUSPLUS=y CONFIG_HEAP_MEM_POOL_SIZE=32768 ``` +Set `CONFIG_ZMK_JAVELIN_STENO_DICT_PLOVER` and `CONFIG_ZMK_JAVELIN_STENO_DICT_LAPWING` to choose which dictionaries to include. Both can be enabled simultaneously. + Add to your `.keymap` (see [steno_keys.h](include/dt-bindings/zmk/javelin_steno.h) for all available key bindings): ```dts @@ -56,11 +64,6 @@ steno_layer { }; ``` -## Known Issues - -- Plover and Lapwing dictionaries exceed nRF52840 flash (1MB). Dictionary embedding works but linker rejects due to flash overflow. -- Boards with external QSPI flash (like the original Javelin hardware) would not have this limitation. - ## License This module is a bridge layer. The Javelin steno engine itself is licensed under [PolyForm Noncommercial 1.0.0](https://polyformproject.org/licenses/noncommercial/1.0.0/).