ClaytonWWilson/miryoku_zmk
1
0
Fork 0
mirror of https://github.com/ClaytonWWilson/miryoku_zmk.git synced 2025-12-13 09:48:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update Corne-ish Zen notes and custom workflow

Browse Source
This commit is contained in:
Manna Harbour 2023-02-02 22:05:54 +11:00
parent b5f0da1b0a
commit c4bd46fd93
3 changed files with 23 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
.github/workflows/build-example-corne-ish_zen-custom.yml vendored
View File

@ -1,14 +0,0 @@
# 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"]'

17
.github/workflows/build-example-corneish_zen-custom.yml vendored Normal file
View File

@ -0,0 +1,17 @@
# Copyright 2023 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: '[
"corneish_zen_v1_left","corneish_zen_v1_right",
"corneish_zen_v2_left","corneish_zen_v2_right"
]'
custom_config: '["#define MIRYOKU_KLUDGE_MOUSEKEYSPR"]'
kconfig: '["CONFIG_ZMK_DISPLAY_HIDE_MOMENTARY_LAYERS=y\nCONFIG_CUSTOM_WIDGET_LAYER_STATUS_HIDE_HEADING=y\nCONFIG_CUSTOM_WIDGET_LOGO_IMAGE_MIRYOKU=y\nCONFIG_IL0323_INVERT=y\nCONFIG_ZMK_MOUSE=y"]'
branches: '["zmkfirmware/zmk/main caksoylar/zmk/caksoylar/zen-v1+v2 ftc/zmk/mouse-ftc"]'

19
readme.org
View File

@ -200,25 +200,18 @@ See https://github.com/manna-harbour/miryoku/discussions/81 for available and su
Notes are provided below for individual keyboards where required.
**** corne-ish_zen
**** 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.
For Corne-ish Zen v1 (GB R1 and R2) build with board ~corneish_zen_v1_left,corneish_zen_v1_right~ and for Corne-ish Zen v2 (GB R3) build with board ~corneish_zen_v2_left,corneish_zen_v2_right~.
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~.
A custom branch is available at https://github.com/caksoylar/zmk/tree/caksoylar/zen-v1+v2 that includes additional display improvements and options. Documentation is at https://gist.github.com/caksoylar/c411313990978e1903c244f03039187a. Options can be selected with [[#kconfig-configuration][Kconfig configuration]].
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 [[#workflow-builds][workflow builds]] using the [[#build-inputs][Build Inputs]] workflow, use ~caksoylar/zmk/caksoylar/zen-v1+v2~ with the ~branches~ option. For workflow builds using [[#build-examples][Build Example]] workflows, see the [[.github/workflows/build-example-corneish_zen-custom.yml][Build Example Corne-ish_Zen Custom]] workflow.
For local builds, make the changes locally.
Corne-ish Zen v1 can also be built with board ~corne-ish_zen_left,corne-ish_zen_right~ using the LowproKB fork, and workflow builds for this board will use this fork by default.
** Config File