3.2 KiB
- Status
Status
Welcome to the alpha of miryoku ZMK!
You've been added as a collaborator to the repo as it's the easiest way to give access. You're not expected to contribute but contributions are welcome. In that case please create a new branch and PR. Otherwise, if you could avoid accidental force pushes to master that'd be great! The layout should be usable now but there's still some work to do before it's published, so please don't redistribute. If you fork, please make the repo private.
Just a bit of an explanation of the current status: I'm doing a miryoku reorganisation at the moment. The general layout docs will move out of the QMK repo and get expanded. The org stuff will also move and will generate QMK, ZMK, and KMonad. At the moment the org stuff in ZMK is separate until I finalise the scripts and re-integrate the changes, so it's a bit of a mess right now but the generated keymap shouldn't change much.
Todo
TODO Integrate with Zephyr CMake
Support passing configuration options. For now, add the equivalent #define to
your keymap before the includes, e.g. for MIRYOKU_ALPHAS=QWERTY add #define
MIRYOKU_ALPHAS_QWERTY.
TODO Add mappings for all boards / shields in ZMK
https://github.com/zmkfirmware/zmk/tree/main/app/boards/shields
TODO bfo9000
split_6x9
MACROPAD boardsource3x4
MACROPAD clueboard_california
DONE corne
DONE cradio
DONE crbn
DONE eek
DONE ferris
DONE helix
DONE iris
DONE jian
DONE jorne
DONE kyria
DONE lily58
ROWSTAGGER m60
60_ansi
DONE microdox
ROWSTAGGER nibble
nibble (65%)
ROWSTAGGER qaz
ROWSTAGGER quefrency
quefrency (65%)
TODO reviung41
MACROPAD romac
MACROPAD romac_plus
DONE sofle
DONE splitreus62
ROWSTAGGER tg4x
40%
MACROPAD tidbit
https://github.com/zmkfirmware/zmk/tree/main/app/boards/arm
NA bdn9
NA bluemicro840
ROWSTAGGER dz60rgb_rev1
can be built as 60_ansi, default in zmk is not
NA nice_nano
NA nrf52840_m2
NA nrfmicro
DONE planck
NA proton_c
PRs
ONEOFF andante
TODO contra
MACROPAD duckboard
TODO ergodash
TODO helix_r
TODO ferris_rev02
TODO levinson
TODO naked60
TODO preonic_rev3 (board)
TODO pockettype
ONEOFF polilla
TODO rebound
TODO reviung39
external
DONE ahokore
TODO corne-ish_zen
name?