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

Update welcome section

Browse Source
This commit is contained in:
Manna Harbour 2021-02-10 16:40:15 +11:00
parent 41995caa85
commit e2ec56b2bb
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
miryoku/miryoku-zmk.org
View File

@ -63,8 +63,9 @@ 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! Please don't redistribute as
it's only the alpha version.
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
@ -81,6 +82,7 @@ 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