From 59d42685a150996a346f0fd6b79ef44ad88a7d64 Mon Sep 17 00:00:00 2001 From: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Date: Wed, 10 Mar 2021 11:22:35 +1100 Subject: [PATCH] Rename mapping files --- config/ahokore.keymap | 2 +- config/corne.keymap | 2 +- config/cradio.keymap | 2 +- config/crbn.keymap | 2 +- config/eek.keymap | 2 +- config/ferris.keymap | 2 +- config/helix.keymap | 2 +- config/iris.keymap | 2 +- config/jian.keymap | 2 +- config/jorne.keymap | 2 +- config/kyria.keymap | 2 +- config/lily58.keymap | 2 +- config/microdox.keymap | 2 +- config/planck.keymap | 2 +- config/sofle.keymap | 2 +- config/splitreus62.keymap | 2 +- .../mapping/{split_3x5_2.h => 34-ferris.h} | 0 .../mapping/{split_3x5_3.h => 36-minidox.h} | 0 miryoku/mapping/{split_3x6_3.h => 42-corne.h} | 0 miryoku/mapping/{jian.h => 44-jian.h} | 0 miryoku/mapping/{ortho_4x12.h => 48-planck.h} | 0 miryoku/mapping/{kyria.h => 50-kyria.h} | 0 miryoku/mapping/{iris.h => 56-iris.h} | 0 miryoku/mapping/{lily58.h => 58-lily58.h} | 0 miryoku/mapping/{sofle.h => 60-sofle.h} | 0 miryoku/mapping/{atreus62.h => 62-atreus62.h} | 0 miryoku/mapping/{helix.h => 64-helix.h} | 0 readme.org | 65 +++++++++---------- status.org | 35 +++++++++- 29 files changed, 79 insertions(+), 53 deletions(-) rename miryoku/mapping/{split_3x5_2.h => 34-ferris.h} (100%) rename miryoku/mapping/{split_3x5_3.h => 36-minidox.h} (100%) rename miryoku/mapping/{split_3x6_3.h => 42-corne.h} (100%) rename miryoku/mapping/{jian.h => 44-jian.h} (100%) rename miryoku/mapping/{ortho_4x12.h => 48-planck.h} (100%) rename miryoku/mapping/{kyria.h => 50-kyria.h} (100%) rename miryoku/mapping/{iris.h => 56-iris.h} (100%) rename miryoku/mapping/{lily58.h => 58-lily58.h} (100%) rename miryoku/mapping/{sofle.h => 60-sofle.h} (100%) rename miryoku/mapping/{atreus62.h => 62-atreus62.h} (100%) rename miryoku/mapping/{helix.h => 64-helix.h} (100%) diff --git a/config/ahokore.keymap b/config/ahokore.keymap index e58b2fa..dcd3d5c 100644 --- a/config/ahokore.keymap +++ b/config/ahokore.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/split_3x5_3.h" +#include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/corne.keymap b/config/corne.keymap index c97c711..3018d98 100644 --- a/config/corne.keymap +++ b/config/corne.keymap @@ -2,5 +2,5 @@ #define MIRYOKU_COMBO_TPS_ENABLE -#include "../miryoku/mapping/split_3x6_3.h" +#include "../miryoku/mapping/42-corne.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/cradio.keymap b/config/cradio.keymap index 047cac9..620a1e6 100644 --- a/config/cradio.keymap +++ b/config/cradio.keymap @@ -1,3 +1,3 @@ -#include "../miryoku/mapping/split_3x5_2.h" +#include "../miryoku/mapping/34-ferris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/crbn.keymap b/config/crbn.keymap index 22a44a3..4503844 100644 --- a/config/crbn.keymap +++ b/config/crbn.keymap @@ -1,5 +1,5 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/ortho_4x12.h" +#include "../miryoku/mapping/48-planck.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/eek.keymap b/config/eek.keymap index e58b2fa..dcd3d5c 100644 --- a/config/eek.keymap +++ b/config/eek.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/split_3x5_3.h" +#include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/ferris.keymap b/config/ferris.keymap index a5502f0..620a1e6 100644 --- a/config/ferris.keymap +++ b/config/ferris.keymap @@ -1,3 +1,3 @@ -#include "../miryoku/mapping/split_3x6_2.h" +#include "../miryoku/mapping/34-ferris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/helix.keymap b/config/helix.keymap index 6264605..4ecdf4a 100644 --- a/config/helix.keymap +++ b/config/helix.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/helix.h" +#include "../miryoku/mapping/64-helix.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/iris.keymap b/config/iris.keymap index 3a09942..5581199 100644 --- a/config/iris.keymap +++ b/config/iris.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/iris.h" +#include "../miryoku/mapping/56-iris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/jian.keymap b/config/jian.keymap index 98c4175..d8116d2 100644 --- a/config/jian.keymap +++ b/config/jian.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/jian.h" +#include "../miryoku/mapping/44-jian.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/jorne.keymap b/config/jorne.keymap index 98c4175..d8116d2 100644 --- a/config/jorne.keymap +++ b/config/jorne.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/jian.h" +#include "../miryoku/mapping/44-jian.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/kyria.keymap b/config/kyria.keymap index fa7c7f5..66d22c3 100644 --- a/config/kyria.keymap +++ b/config/kyria.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/kyria.h" +#include "../miryoku/mapping/50-kyria.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/lily58.keymap b/config/lily58.keymap index a68ad32..d24a6d7 100644 --- a/config/lily58.keymap +++ b/config/lily58.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/lily58.h" +#include "../miryoku/mapping/58-lily58.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/microdox.keymap b/config/microdox.keymap index e58b2fa..dcd3d5c 100644 --- a/config/microdox.keymap +++ b/config/microdox.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/split_3x5_3.h" +#include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/planck.keymap b/config/planck.keymap index 22a44a3..4503844 100644 --- a/config/planck.keymap +++ b/config/planck.keymap @@ -1,5 +1,5 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/ortho_4x12.h" +#include "../miryoku/mapping/48-planck.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/sofle.keymap b/config/sofle.keymap index 5654f5e..d4ac050 100644 --- a/config/sofle.keymap +++ b/config/sofle.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/sofle.h" +#include "../miryoku/mapping/60-sofle.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/splitreus62.keymap b/config/splitreus62.keymap index fa7ea57..72fa4db 100644 --- a/config/splitreus62.keymap +++ b/config/splitreus62.keymap @@ -1,4 +1,4 @@ // https://github.com/manna-harbour/miryoku-zmk/ -#include "../miryoku/mapping/atreus62.h" +#include "../miryoku/mapping/62-atreus62.h" #include "../miryoku/miryoku.dtsi" diff --git a/miryoku/mapping/split_3x5_2.h b/miryoku/mapping/34-ferris.h similarity index 100% rename from miryoku/mapping/split_3x5_2.h rename to miryoku/mapping/34-ferris.h diff --git a/miryoku/mapping/split_3x5_3.h b/miryoku/mapping/36-minidox.h similarity index 100% rename from miryoku/mapping/split_3x5_3.h rename to miryoku/mapping/36-minidox.h diff --git a/miryoku/mapping/split_3x6_3.h b/miryoku/mapping/42-corne.h similarity index 100% rename from miryoku/mapping/split_3x6_3.h rename to miryoku/mapping/42-corne.h diff --git a/miryoku/mapping/jian.h b/miryoku/mapping/44-jian.h similarity index 100% rename from miryoku/mapping/jian.h rename to miryoku/mapping/44-jian.h diff --git a/miryoku/mapping/ortho_4x12.h b/miryoku/mapping/48-planck.h similarity index 100% rename from miryoku/mapping/ortho_4x12.h rename to miryoku/mapping/48-planck.h diff --git a/miryoku/mapping/kyria.h b/miryoku/mapping/50-kyria.h similarity index 100% rename from miryoku/mapping/kyria.h rename to miryoku/mapping/50-kyria.h diff --git a/miryoku/mapping/iris.h b/miryoku/mapping/56-iris.h similarity index 100% rename from miryoku/mapping/iris.h rename to miryoku/mapping/56-iris.h diff --git a/miryoku/mapping/lily58.h b/miryoku/mapping/58-lily58.h similarity index 100% rename from miryoku/mapping/lily58.h rename to miryoku/mapping/58-lily58.h diff --git a/miryoku/mapping/sofle.h b/miryoku/mapping/60-sofle.h similarity index 100% rename from miryoku/mapping/sofle.h rename to miryoku/mapping/60-sofle.h diff --git a/miryoku/mapping/atreus62.h b/miryoku/mapping/62-atreus62.h similarity index 100% rename from miryoku/mapping/atreus62.h rename to miryoku/mapping/62-atreus62.h diff --git a/miryoku/mapping/helix.h b/miryoku/mapping/64-helix.h similarity index 100% rename from miryoku/mapping/helix.h rename to miryoku/mapping/64-helix.h diff --git a/readme.org b/readme.org index 95107f5..375dca8 100644 --- a/readme.org +++ b/readme.org @@ -10,14 +10,18 @@ orthogonal, universal keyboard layout. This is the miryoku implementation for - [[#miryoku-keymap][Miryoku Keymap]] - [[#configuration-options][Configuration Options]] - [[#mapping][Mapping]] - - [[#generic-layouts][Generic Layouts]] - - [[#jian][jian]] - - [[#ortho_4x12][ortho_4x12]] - - [[#split_3x5_2][split_3x5_2]] - - [[#split_3x5_3][split_3x5_3]] - - [[#split_3x6_3][split_3x6_3]] - - [[#keyboard-specific-layouts][Keyboard-Specific Layouts]] - - [[#kyria][kyria]] + - [[#layouts][Layouts]] + - [[#34-ferris][34-ferris]] + - [[#36-minidox][36-minidox]] + - [[#42-corne][42-corne]] + - [[#44-jian][44-jian]] + - [[#48-planck][48-planck]] + - [[#50-kyria][50-kyria]] + - [[#56-iris][56-iris]] + - [[#58-lily58][58-lily58]] + - [[#60-sofle][60-sofle]] + - [[#62-atreus62][62-atreus62]] + - [[#64-helix][64-helix]] - [[#keyboard-keymaps][Keyboard Keymaps]] - [[#prebuilt-firmware][Prebuilt Firmware]] - [[#contact][Contact]] @@ -49,59 +53,48 @@ mapping file is included into the keyboard's keymap file before the miryoku keymap with e.g. #+BEGIN_SRC C :tangle no -#include "../miryoku/mapping/split_3x5_3.dtsi" +#include "../miryoku/mapping/36-minidox.h" #+END_SRC On each hand, only the main alpha block of 3 rows by 5 columns and the 3 most appropriate thumb keys are used. Notes or diagrams are included where the selection of keys is not obvious or where options are provided. -** Generic Layouts +** Layouts -These mappings can be used by multiple keyboards with functionally identical physical layouts. - -todo - -*** jian - -Used by: - -- jian -- jorne - -*** [[./miryoku/mapping/ortho_4x12.h][ortho_4x12]] - -[[https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/mapping/miryoku-kle-mapping-ortho_4x12.png]] - - -*** [[./miryoku/mapping/split_3x5_2.h][split_3x5_2]] +*** 34-ferris Combos of primary and secondary thumb keys emulate the missing tertiary thumb key. To enable with other subset mappings for compatibility, add ~#define MIRYOKU_COMBO_TPS_ENABLE~ to the keymap before the includes. -*** [[./miryoku/mapping/split_3x5_3.h][split_3x5_3]] +*** 36-minidox +*** 42-corne -*** [[./miryoku/mapping/split_3x6_3.h][split_3x6_3]] +*** 44-jian +*** 48-planck - -** Keyboard-Specific Layouts - -todo - -*** [[./miryoku/mapping/kyria.h][kyria]] +*** 50-kyria [[https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/mapping/miryoku-kle-mapping-kyria.png]] +*** 56-iris + +*** 58-lily58 + +*** 60-sofle + +*** 62-atreus62 + +*** 64-helix * Keyboard Keymaps 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 diff --git a/status.org b/status.org index f35a464..54d264f 100644 --- a/status.org +++ b/status.org @@ -27,7 +27,7 @@ MIRYOKU_ALPHAS_QWERTY~. *** TODO Add mappings for all boards / shields in ZMK -#+TODO: TODO | DONE NA MACROPAD ROWSTAGGER +#+TODO: TODO | DONE NA MACROPAD ROWSTAGGER ONEOFF **** https://github.com/zmkfirmware/zmk/tree/main/app/boards/shields @@ -78,6 +78,39 @@ can be built as 60_ansi, default in zmk is not ***** NA proton_c +**** PRs + +***** ONEOFF andante +https://github.com/zmkfirmware/zmk/pull/654/files +***** TODO bastyl +https://github.com/zmkfirmware/zmk/pull/604/files +***** TODO contra +https://github.com/zmkfirmware/zmk/pull/633 +***** MACROPAD duckboard +***** TODO ergodash +https://github.com/zmkfirmware/zmk/pull/572 +***** TODO helix_r +https://github.com/zmkfirmware/zmk/pull/585 +***** TODO ferris_rev02 +https://github.com/zmkfirmware/zmk/pull/642/files +***** TODO levinson +https://github.com/zmkfirmware/zmk/pull/566 +***** TODO naked60 +https://github.com/zmkfirmware/zmk/pull/681/files +***** TODO preonic_rev3 (board) +https://github.com/zmkfirmware/zmk/pull/228 +***** TODO pockettype +https://github.com/zmkfirmware/zmk/pull/672/files +***** ONEOFF polilla +https://github.com/zmkfirmware/zmk/pull/612 +***** TODO rebound +https://github.com/zmkfirmware/zmk/pull/546 +***** TODO reviung39 +https://github.com/zmkfirmware/zmk/pull/695/files +https://github.com/zmkfirmware/zmk/pull/622 +***** TODO ut47 +https://github.com/zmkfirmware/zmk/pull/641 + **** external ***** DONE ahokore