From 3284747ff03eea5ce0f06ad46383b443ed30283a Mon Sep 17 00:00:00 2001 From: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Date: Fri, 5 Mar 2021 20:38:57 +1100 Subject: [PATCH] Add prebuilt firmware section to docs --- readme.org | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/readme.org b/readme.org index 0539ee8..95107f5 100644 --- a/readme.org +++ b/readme.org @@ -19,6 +19,7 @@ orthogonal, universal keyboard layout. This is the miryoku implementation for - [[#keyboard-specific-layouts][Keyboard-Specific Layouts]] - [[#kyria][kyria]] - [[#keyboard-keymaps][Keyboard Keymaps]] +- [[#prebuilt-firmware][Prebuilt Firmware]] - [[#contact][Contact]] * Miryoku Keymap @@ -59,6 +60,8 @@ selection of keys is not obvious or where options are provided. These mappings can be used by multiple keyboards with functionally identical physical layouts. +todo + *** jian Used by: @@ -86,6 +89,8 @@ MIRYOKU_COMBO_TPS_ENABLE~ to the keymap before the includes. ** Keyboard-Specific Layouts +todo + *** [[./miryoku/mapping/kyria.h][kyria]] [[https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/mapping/miryoku-kle-mapping-kyria.png]] @@ -97,9 +102,19 @@ Keymap files for many keyboards included in ZMK are provided in [[./config/][config/]]. +* Prebuilt Firmware + +Prebuilt firmware for supported keyboards, built with the default configuration +options, can be downloaded from the repo. From the +[[https://github.com/manna-harbour/miryoku-zmk/actions][Actions]] tab select the +latest successful workflow run, then select the keyboard in the Artifacts +section. + * Contact -To request any of the following, please create an issue. Pull requests are also welcome. +For issues with the code, including requests for any of the following, please +[[https://github.com/manna-harbour/miryoku-zmk/issues/new][create an issue]]. +Pull requests are also welcome. - Additional mapping and keyboard keymap files - Additional mapping options (see miryoku QMK for examples)