diff --git a/config/absolem.keymap b/config/absolem.keymap index aed12d6..1481841 100644 --- a/config/absolem.keymap +++ b/config/absolem.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/ahokore.keymap b/config/ahokore.keymap index aed12d6..1481841 100644 --- a/config/ahokore.keymap +++ b/config/ahokore.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/architeuthis_dux.keymap b/config/architeuthis_dux.keymap index 33eb48e..2dd65e0 100644 --- a/config/architeuthis_dux.keymap +++ b/config/architeuthis_dux.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/34-ferris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/bastyl.keymap b/config/bastyl.keymap index 1c13f8e..3e894ba 100644 --- a/config/bastyl.keymap +++ b/config/bastyl.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/58-bastyl.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/ble_chiffre.keymap b/config/ble_chiffre.keymap index 59cc89a..7f701c0 100644 --- a/config/ble_chiffre.keymap +++ b/config/ble_chiffre.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/34-ble_chiffre.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/boardsource5x12.keymap b/config/boardsource5x12.keymap index 3ad3200..9a7d178 100644 --- a/config/boardsource5x12.keymap +++ b/config/boardsource5x12.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/60-preonic.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/contra.keymap b/config/contra.keymap index a5eba21..9dcae41 100644 --- a/config/contra.keymap +++ b/config/contra.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/48-planck.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/corne-ish_zen.keymap b/config/corne-ish_zen.keymap index ed11ad8..0fb576f 100644 --- a/config/corne-ish_zen.keymap +++ b/config/corne-ish_zen.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/42-corne.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/corne.keymap b/config/corne.keymap index ed11ad8..0fb576f 100644 --- a/config/corne.keymap +++ b/config/corne.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/42-corne.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/cradio.keymap b/config/cradio.keymap index 33eb48e..2dd65e0 100644 --- a/config/cradio.keymap +++ b/config/cradio.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/34-ferris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/cradio36.keymap b/config/cradio36.keymap index aed12d6..1481841 100644 --- a/config/cradio36.keymap +++ b/config/cradio36.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/cradios.keymap b/config/cradios.keymap index aed12d6..1481841 100644 --- a/config/cradios.keymap +++ b/config/cradios.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/cradioz.keymap b/config/cradioz.keymap index 33eb48e..2dd65e0 100644 --- a/config/cradioz.keymap +++ b/config/cradioz.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/34-ferris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/crbn.keymap b/config/crbn.keymap index a5eba21..9dcae41 100644 --- a/config/crbn.keymap +++ b/config/crbn.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/48-planck.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/eek.keymap b/config/eek.keymap index aed12d6..1481841 100644 --- a/config/eek.keymap +++ b/config/eek.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/ergodash.keymap b/config/ergodash.keymap index 253aa9b..53ecd1d 100644 --- a/config/ergodash.keymap +++ b/config/ergodash.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/70-ergodash.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/ferris_rev02.keymap b/config/ferris_rev02.keymap index 33eb48e..2dd65e0 100644 --- a/config/ferris_rev02.keymap +++ b/config/ferris_rev02.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/34-ferris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/helix.keymap b/config/helix.keymap index 6dda136..c793c5b 100644 --- a/config/helix.keymap +++ b/config/helix.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/64-helix.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/iris.keymap b/config/iris.keymap index c1e193d..8a598e6 100644 --- a/config/iris.keymap +++ b/config/iris.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/56-iris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/jian.keymap b/config/jian.keymap index 159f484..2ac5ec9 100644 --- a/config/jian.keymap +++ b/config/jian.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/44-jian.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/jorne.keymap b/config/jorne.keymap index 159f484..2ac5ec9 100644 --- a/config/jorne.keymap +++ b/config/jorne.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/44-jian.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/kyria.keymap b/config/kyria.keymap index bf5d082..1061eeb 100644 --- a/config/kyria.keymap +++ b/config/kyria.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/50-kyria.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/levinson.keymap b/config/levinson.keymap index 24b20dd..2c627c4 100644 --- a/config/levinson.keymap +++ b/config/levinson.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/48-lets_split.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/lily58.keymap b/config/lily58.keymap index f094079..7a5b5aa 100644 --- a/config/lily58.keymap +++ b/config/lily58.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/58-lily.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/microdox.keymap b/config/microdox.keymap index ba0e2a4..cf29021 100644 --- a/config/microdox.keymap +++ b/config/microdox.keymap @@ -1,6 +1,7 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/naked60.keymap b/config/naked60.keymap index 67c8b0c..13f3234 100644 --- a/config/naked60.keymap +++ b/config/naked60.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/60-naked.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/planck_rev6.keymap b/config/planck_rev6.keymap index a5eba21..9dcae41 100644 --- a/config/planck_rev6.keymap +++ b/config/planck_rev6.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/48-planck.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/pockettype.keymap b/config/pockettype.keymap index a5eba21..9dcae41 100644 --- a/config/pockettype.keymap +++ b/config/pockettype.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/48-planck.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/preonic_rev3.keymap b/config/preonic_rev3.keymap index 3ad3200..9a7d178 100644 --- a/config/preonic_rev3.keymap +++ b/config/preonic_rev3.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/60-preonic.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/pteron36.keymap b/config/pteron36.keymap index aed12d6..1481841 100644 --- a/config/pteron36.keymap +++ b/config/pteron36.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/36-minidox.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/rebound_v4.keymap b/config/rebound_v4.keymap index 50dec8d..e666b07 100644 --- a/config/rebound_v4.keymap +++ b/config/rebound_v4.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/63-rebound.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/reviung39.keymap b/config/reviung39.keymap index 8d524df..6e7c547 100644 --- a/config/reviung39.keymap +++ b/config/reviung39.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/39-reviung.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/reviung41.keymap b/config/reviung41.keymap index 5bd8c1c..ce762e8 100644 --- a/config/reviung41.keymap +++ b/config/reviung41.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/41-reviung.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/sofle.keymap b/config/sofle.keymap index c446a0f..d49808e 100644 --- a/config/sofle.keymap +++ b/config/sofle.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/60-sofle.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/splitreus62.keymap b/config/splitreus62.keymap index e0e03f1..2c6e501 100644 --- a/config/splitreus62.keymap +++ b/config/splitreus62.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/62-atreus.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/sweepv2.keymap b/config/sweepv2.keymap index 33eb48e..2dd65e0 100644 --- a/config/sweepv2.keymap +++ b/config/sweepv2.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/34-ferris.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/tbkmini.keymap b/config/tbkmini.keymap index ed11ad8..0fb576f 100644 --- a/config/tbkmini.keymap +++ b/config/tbkmini.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/42-corne.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/tightyl.keymap b/config/tightyl.keymap index b1774f6..3733a24 100644 --- a/config/tightyl.keymap +++ b/config/tightyl.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/46-tightyl.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/viterbi.keymap b/config/viterbi.keymap index e6563cd..3feccc3 100644 --- a/config/viterbi.keymap +++ b/config/viterbi.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/70-viterbi.h" #include "../miryoku/miryoku.dtsi" diff --git a/config/zaphod.keymap b/config/zaphod.keymap index 33eb48e..2dd65e0 100644 --- a/config/zaphod.keymap +++ b/config/zaphod.keymap @@ -1,5 +1,6 @@ // Copyright 2021 Manna Harbour // https://github.com/manna-harbour/miryoku +#include "../miryoku/config.h" #include "../miryoku/mapping/34-ferris.h" #include "../miryoku/miryoku.dtsi" diff --git a/miryoku/miryoku-zmk-babel.org b/miryoku/miryoku-zmk-babel.org index c28af1e..73da634 100644 --- a/miryoku/miryoku-zmk-babel.org +++ b/miryoku/miryoku-zmk-babel.org @@ -693,7 +693,6 @@ standard keycode to implementation equivalent #include #include #include -#include "config.h" <> diff --git a/miryoku/miryoku.dtsi b/miryoku/miryoku.dtsi index cc69ffc..3001e92 100644 --- a/miryoku/miryoku.dtsi +++ b/miryoku/miryoku.dtsi @@ -7,7 +7,6 @@ #include #include #include -#include "config.h" #define BASE 0 #define TAP 1 diff --git a/readme.org b/readme.org index 8ec046a..b84baed 100644 --- a/readme.org +++ b/readme.org @@ -71,7 +71,7 @@ Some prebuilt firmware is available from previous workflow runs. * Miryoku Keymap -The Miryoku keymap is a ZMK DT keymap file using C preprocessor macros for [[#configuration-options][configuration options]] and to abstract the physical layout. The file is [[miryoku/miryoku.dtsi]]. The file is included into the [[#keyboard-keymaps][keyboard's keymap]] with +The Miryoku keymap is a ZMK DT keymap file using C preprocessor macros for [[#configuration-options][configuration options]] and to abstract the physical layout. The file is [[miryoku/miryoku.dtsi]]. The file is included into the [[#keyboard-keymaps][keyboard's keymap]] after the config file and mapping with: #+BEGIN_SRC C :tangle no #include "../miryoku/miryoku.dtsi" @@ -83,20 +83,23 @@ The Miryoku keymap is a ZMK DT keymap file using C preprocessor macros for [[#co [[https://github.com/manna-harbour/qmk_firmware/blob/miryoku/users/manna-harbour_miryoku/miryoku.org#alternative-layouts][Keymap configuration options]] and [[#mapping][mapping]] configuration options are given in the documentation in the form ~option=value~. -** in Config File +** Use in Local Builds -Convert to the form ~#define option_value~. To apply the configuration options to all builds add them to the [[#config-file][config file]]. To apply configuration options to a single keyboard, add them to the [[#keyboard-keymaps][keyboard keymap]] file before any ~#include~ lines. +Convert to the form ~#define option_value~ and add to the [[#config-file][config file]]. -** in Workflows +** Use in Workflow Builds Convert to the form ~value~ (uppercase or lowercase) and use with the corresponding ~option~. Use ~default~ to represent the default value. * Config File -The config file can be used to provide [[#configuration-options][configuration options]] for all [[#Local-Builds][local builds]]. The file is [[miryoku/config.h]]. See the [[#example-config-file][example config file]]. +The config file can be used to provide [[#configuration-options][configuration options]] for all [[#Local-Builds][local builds]]. The file is [[miryoku/config.h]]. See the [[#example-config-file][example config file]]. The config file is included into the keyboard's keymap file before the mapping with: +#+BEGIN_SRC C :tangle no +#include "../miryoku/config.h" +#+END_SRC * Example Config File