Rename mapping files

This commit is contained in:
Manna Harbour 2021-03-10 11:22:35 +11:00
parent df70defd30
commit 59d42685a1
29 changed files with 79 additions and 53 deletions

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/split_3x5_3.h" #include "../miryoku/mapping/36-minidox.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -2,5 +2,5 @@
#define MIRYOKU_COMBO_TPS_ENABLE #define MIRYOKU_COMBO_TPS_ENABLE
#include "../miryoku/mapping/split_3x6_3.h" #include "../miryoku/mapping/42-corne.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,3 +1,3 @@
#include "../miryoku/mapping/split_3x5_2.h" #include "../miryoku/mapping/34-ferris.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,5 +1,5 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/ortho_4x12.h" #include "../miryoku/mapping/48-planck.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/split_3x5_3.h" #include "../miryoku/mapping/36-minidox.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,3 +1,3 @@
#include "../miryoku/mapping/split_3x6_2.h" #include "../miryoku/mapping/34-ferris.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/helix.h" #include "../miryoku/mapping/64-helix.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/iris.h" #include "../miryoku/mapping/56-iris.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/jian.h" #include "../miryoku/mapping/44-jian.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/jian.h" #include "../miryoku/mapping/44-jian.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/kyria.h" #include "../miryoku/mapping/50-kyria.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/lily58.h" #include "../miryoku/mapping/58-lily58.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/split_3x5_3.h" #include "../miryoku/mapping/36-minidox.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,5 +1,5 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/ortho_4x12.h" #include "../miryoku/mapping/48-planck.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/sofle.h" #include "../miryoku/mapping/60-sofle.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -1,4 +1,4 @@
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#include "../miryoku/mapping/atreus62.h" #include "../miryoku/mapping/62-atreus62.h"
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"

View File

@ -10,14 +10,18 @@ orthogonal, universal keyboard layout. This is the miryoku implementation for
- [[#miryoku-keymap][Miryoku Keymap]] - [[#miryoku-keymap][Miryoku Keymap]]
- [[#configuration-options][Configuration Options]] - [[#configuration-options][Configuration Options]]
- [[#mapping][Mapping]] - [[#mapping][Mapping]]
- [[#generic-layouts][Generic Layouts]] - [[#layouts][Layouts]]
- [[#jian][jian]] - [[#34-ferris][34-ferris]]
- [[#ortho_4x12][ortho_4x12]] - [[#36-minidox][36-minidox]]
- [[#split_3x5_2][split_3x5_2]] - [[#42-corne][42-corne]]
- [[#split_3x5_3][split_3x5_3]] - [[#44-jian][44-jian]]
- [[#split_3x6_3][split_3x6_3]] - [[#48-planck][48-planck]]
- [[#keyboard-specific-layouts][Keyboard-Specific Layouts]] - [[#50-kyria][50-kyria]]
- [[#kyria][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]] - [[#keyboard-keymaps][Keyboard Keymaps]]
- [[#prebuilt-firmware][Prebuilt Firmware]] - [[#prebuilt-firmware][Prebuilt Firmware]]
- [[#contact][Contact]] - [[#contact][Contact]]
@ -49,59 +53,48 @@ mapping file is included into the keyboard's keymap file before the miryoku
keymap with e.g. keymap with e.g.
#+BEGIN_SRC C :tangle no #+BEGIN_SRC C :tangle no
#include "../miryoku/mapping/split_3x5_3.dtsi" #include "../miryoku/mapping/36-minidox.h"
#+END_SRC #+END_SRC
On each hand, only the main alpha block of 3 rows by 5 columns and the 3 most 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 appropriate thumb keys are used. Notes or diagrams are included where the
selection of keys is not obvious or where options are provided. 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. *** 34-ferris
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]]
Combos of primary and secondary thumb keys emulate the missing tertiary thumb Combos of primary and secondary thumb keys emulate the missing tertiary thumb
key. To enable with other subset mappings for compatibility, add ~#define key. To enable with other subset mappings for compatibility, add ~#define
MIRYOKU_COMBO_TPS_ENABLE~ to the keymap before the includes. 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
*** 50-kyria
** Keyboard-Specific Layouts
todo
*** [[./miryoku/mapping/kyria.h][kyria]]
[[https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/mapping/miryoku-kle-mapping-kyria.png]] [[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 * Keyboard Keymaps
Keymap files for many keyboards included in ZMK are provided in Keymap files for many keyboards included in ZMK are provided in
[[./config/][config/]]. [[./config/][config/]].
* Prebuilt Firmware * Prebuilt Firmware
Prebuilt firmware for supported keyboards, built with the default configuration Prebuilt firmware for supported keyboards, built with the default configuration

View File

@ -27,7 +27,7 @@ MIRYOKU_ALPHAS_QWERTY~.
*** TODO Add mappings for all boards / shields in ZMK *** 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 **** 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 ***** 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 **** external
***** DONE ahokore ***** DONE ahokore