From fe5af54a755994532fdfd3477f2c16d5d00bf14d Mon Sep 17 00:00:00 2001 From: Manna Harbour <51143715+manna-harbour@users.noreply.github.com> Date: Mon, 7 Jun 2021 11:40:03 +1000 Subject: [PATCH] Rename status.org to welcome.org and update --- status.org | 119 ---------------------------------------------------- welcome.org | 25 +++++++++++ 2 files changed, 25 insertions(+), 119 deletions(-) delete mode 100644 status.org create mode 100644 welcome.org diff --git a/status.org b/status.org deleted file mode 100644 index 54d264f..0000000 --- a/status.org +++ /dev/null @@ -1,119 +0,0 @@ -* 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 - -#+TODO: TODO | DONE NA MACROPAD ROWSTAGGER ONEOFF - -**** 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 -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 - -***** DONE ahokore -***** TODO corne-ish_zen - name? - diff --git a/welcome.org b/welcome.org new file mode 100644 index 0000000..ca1196b --- /dev/null +++ b/welcome.org @@ -0,0 +1,25 @@ +* Welcome + +Welcome to the Miryoku ZMK alpha! + +There's still some work to do before it's published, so please don't +redistribute. If you fork, please make the fork private. + +You've been added as a collaborator to the repo as it's the easiest way to give +access. If you could avoid accidental force pushes to master that'd be great! +You're not expected to contribute but contributions are of course welcome. In +that case please create a new branch and PR. + +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 more. 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 and is fine to use now. + +Please see https://github.com/manna-harbour/zmk-config/. +The docs are still being written but should cover how it's set up. Please let +me know if you have any issues. + + +