diff --git a/.github/workflows/build-example-corne-ish_zen-custom.yml b/.github/workflows/build-example-corne-ish_zen-custom.yml new file mode 100644 index 0000000..9d47d52 --- /dev/null +++ b/.github/workflows/build-example-corne-ish_zen-custom.yml @@ -0,0 +1,14 @@ +# Copyright 2022 Manna Harbour +# https://github.com/manna-harbour/miryoku + +name: 'Build Example corne-ish_zen custom' +on: workflow_dispatch +jobs: + build: + uses: ./.github/workflows/main.yml + secrets: inherit + with: + board: '["corne-ish_zen_left","corne-ish_zen_right"]' + custom_config: '["#define MIRYOKU_KLUDGE_MOUSEKEYSPR"]' + kconfig: '["CONFIG_ZMK_MOUSE=y\nCONFIG_ZMK_DISPLAY_HIDE_MOMENTARY_LAYERS=y\nCONFIG_CUSTOM_WIDGET_LOGO_IMAGE_MIRYOKU=y\nCONFIG_IL0323_INVERT=y"]' + branches: '["manna-harbour/zmk/zen zmkfirmware/zmk/main ftc/zmk/mouse-ftc"]' diff --git a/readme.org b/readme.org index 950f0e6..ada69f7 100644 --- a/readme.org +++ b/readme.org @@ -184,6 +184,31 @@ See [[.github/workflows/outboards]] for details of supported out-of-tree keyboar See https://github.com/manna-harbour/miryoku/discussions/81 for available and supported in-tree and out-of-tree keyboards and current maintenance status. +*** Notes + +Notes are provided below for individual keyboards where required. + + +**** corne-ish_zen + +The default ZMK fork for ~corne-ish_zen~ is https://github.com/LOWPROKB/zmk/tree/Board-Corne-ish-Zen-dedicated-work-queue. + +A custom branch is available at https://github.com/manna-harbour/zmk/tree/zen. The branch is based on https://github.com/caksoylar/zmk/tree/caksoylar/zen-on-main which adds compatibility with ZMK ~main~. + +Extra features have also been added which can be selected with the following [[#kconfig-configuration][Kconfig configuration]] options. + +- ~CONFIG_ZMK_DISPLAY_HIDE_MOMENTARY_LAYERS=y~ Suppress layer widget updates for momentary layer changes. +- ~CONFIG_CUSTOM_WIDGET_LOGO_IMAGE_ZEN=y~ Corne-ish Zen logo (default). +- ~CONFIG_CUSTOM_WIDGET_LOGO_IMAGE_ZMK=y~ ZMK logo. +- ~CONFIG_CUSTOM_WIDGET_LOGO_IMAGE_LPKB=y~ LowproKB logo. +- ~CONFIG_CUSTOM_WIDGET_LOGO_IMAGE_MIRYOKU=y~ Miryoku logo. +- ~CONFIG_IL0323_INVERT=y~ Invert display. + +For [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~manna-harbour/zmk/zen~ with the ~branches~ option. For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-corne-ish_zen-custom.yml][Build Example corne-ish_zen custom]] workflow. + +For local builds, make the changes locally. + + ** Config File The config file is used to specify [[https://github.com/manna-harbour/miryoku/tree/master/docs/reference#alternative-layouts][alternative layout]] and [[#mapping-macros][mapping]] options for [[#Local-Builds][local builds]]. Options are given in the documentation in the form ~MIRYOKU_OPTION=VALUE~. Convert to the form ~#define MIRYOKU_OPTION_VALUE~ and add to the config file.