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

Add config.h docs and unfill pars

Browse Source
This commit is contained in:
Manna Harbour 2021-05-04 16:01:59 +10:00
parent a37e666a43
commit 4c357422af
1 changed files with 26 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
readme.org
View File

@ -2,14 +2,13 @@
[[https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/cover/miryoku-kle-cover.png]] [[https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/cover/miryoku-kle-cover.png]]
[[https://github.com/manna-harbour/miryoku/][Miryoku]] is an ergonomic, minimal, [[https://github.com/manna-harbour/miryoku/][Miryoku]] is an ergonomic, minimal, orthogonal, and universal keyboard layout. This is the miryoku implementation for [[https://zmkfirmware.dev/][ZMK]].
orthogonal, and universal keyboard layout. This is the miryoku implementation
for [[https://zmkfirmware.dev/][ZMK]].
* Contents :TOC_1: * Contents :TOC_1:
- [[#miryoku-keymap][Miryoku Keymap]] - [[#miryoku-keymap][Miryoku Keymap]]
- [[#configuration-options][Configuration Options]] - [[#configuration-options][Configuration Options]]
- [[#example-keyboard-keymap][Example Keyboard Keymap]] - [[#config-file][Config File]]
- [[#example-config-file][Example Config File]]
- [[#mapping][Mapping]] - [[#mapping][Mapping]]
- [[#keyboard-keymaps][Keyboard Keymaps]] - [[#keyboard-keymaps][Keyboard Keymaps]]
- [[#prebuilt-firmware][Prebuilt Firmware]] - [[#prebuilt-firmware][Prebuilt Firmware]]
@ -17,10 +16,7 @@ for [[https://zmkfirmware.dev/][ZMK]].
* Miryoku Keymap * Miryoku Keymap
The miryoku keymap is a ZMK DT keymap file using C preprocessor macros for The miryoku keymap is a ZMK DT keymap file using C preprocessor macros for [[#configuration-options][configuration options]] and to abstract the physical layout. The file is [[./miryoku/miryoku.dtsi][miryoku/miryoku.dtsi]]. The file is included into the [[#keyboard-keymaps][keyboard's keymap]] with
[[#configuration-options][configuration options]] and to abstract the physical
layout. The file is [[./miryoku/miryoku.dtsi][miryoku/miryoku.dtsi]]. The file
is included into the [[#keyboard-keymaps][keyboard's keymap]] with
#+BEGIN_SRC C :tangle no #+BEGIN_SRC C :tangle no
#include "../miryoku/miryoku.dtsi" #include "../miryoku/miryoku.dtsi"
@ -29,22 +25,17 @@ is included into the [[#keyboard-keymaps][keyboard's keymap]] with
* Configuration Options * Configuration Options
[[https://github.com/manna-harbour/miryoku/blob/master/src/babel/readme.org#keymap-configuration-options][Keymap [[https://github.com/manna-harbour/miryoku/blob/master/src/babel/readme.org#keymap-configuration-options][Keymap configuration options]] and [[#mapping][mapping]] configuration options are given in the documentation in the form ~option=value~. To use configuration options in Miryoku ZMK, convert to the form ~#define option_value~. To apply the configuration options to all builds add them to the [[#config-file][config file]]. To apply configuration options to a single keyboard, add them to the [[#keyboard-keymaps][keyboard keymap]] file before any ~#include~ lines.
configuration options]] and [[#mapping][mapping]] configuration options are
given in the documentation in the form ~option=value~. To use configuration
options in Miryoku ZMK, convert to the form ~#define option_value~ and add to
the [[#keyboard-keymaps][keyboard keymap]] file before the [[#mapping][mapping]]
or [[#miryoku-keymap][miryoku keymap]] includes. See the
[[#example-keyboard-keymap][example keyboard keymap]].
* Example Keyboard Keymap * Config File
Below is an example [[#keyboard-keymaps][keyboard keymap file]] for the ~kyria~ The config file can be used to provide [[#configuration-options][configuration options]] for all keyboard builds. The file is [[./miryoku/config.h][miryoku/config.h]]. See the [[#example-config-file][example config file]].
shield using the ~50-kyria~ [[#mapping][mapping]] with
~MIRYOKU_MAPPING=EXTENDED_THUMBS~ mapping
[[#configuration-options][configuration option]] and the following layout * Example Config File
[[#configuration-options][configuration options]]:
Below is an example [[#config-file][config file]] with the following keymap [[#configuration-options][configuration options]]:
- ~MIRYOKU_ALPHAS=QWERTY~ - ~MIRYOKU_ALPHAS=QWERTY~
- ~MIRYOKU_NAV=VI~ - ~MIRYOKU_NAV=VI~
@ -53,39 +44,29 @@ shield using the ~50-kyria~ [[#mapping][mapping]] with
#+BEGIN_SRC C :tangle nos #+BEGIN_SRC C :tangle nos
// https://github.com/manna-harbour/miryoku-zmk/ // https://github.com/manna-harbour/miryoku-zmk/
#define MIRYOKU_MAPPING_EXTENDED_THUMBS
#define MIRYOKU_ALPHAS_QWERTY #define MIRYOKU_ALPHAS_QWERTY
#define MIRYOKU_NAV_VI #define MIRYOKU_NAV_VI
#define MIRYOKU_CLIPBOARD_WIN #define MIRYOKU_CLIPBOARD_WIN
#include "../miryoku/mapping/50-kyria.h"
#include "../miryoku/miryoku.dtsi"
#+END_SRC #+END_SRC
* Mapping * Mapping
The keymap is mapped onto keyboards with different physical layouts. The keymap The keymap is mapped onto keyboards with different physical layouts. The keymap is specified in terms of the ~MIRYOKU_MAPPING~ macro. The macro is defined in a C header file for each physical layout. Unused keys are mapped to ~&none~. The files are in [[./miryoku/mapping/][miryoku/mapping/]]. The mapping file is included into the keyboard's keymap file before the miryoku keymap with e.g.
is specified in terms of the ~MIRYOKU_MAPPING~ macro. The macro is defined in a
C header file for each physical layout. Unused keys are mapped to ~&none~. The
files are in [[./miryoku/mapping/][miryoku/mapping/]]. The
mapping file is included into the keyboard's keymap file before the miryoku
keymap with e.g.
#+BEGIN_SRC C :tangle no #+BEGIN_SRC C :tangle no
#include "../miryoku/mapping/36-minidox.h" #include "../miryoku/mapping/36-minidox.h"
#+END_SRC #+END_SRC
On each hand, only the main alpha block of 3 rows by 5 columns and the 3 most On each hand, only the main alpha block of 3 rows by 5 columns and the 3 most appropriate thumb keys are used. Notes or diagrams are included where the selection of keys is not obvious or where alternatives are provided via mapping [[#configuration-options][configuration options]].
appropriate thumb keys are used. Notes or diagrams are included where the
selection of keys is not obvious or where options are provided.
Configuration options
** Layouts ** Layouts
*** 34-ferris *** 34-ferris
**** Combo TPS **** Combo TPS
~MIRYOKU_COMBO_TPS=ENABLE~ ~MIRYOKU_COMBO_TPS=ENABLE~
@ -98,18 +79,24 @@ compatibility
*** 36-minidox *** 36-minidox
*** 42-corne *** 42-corne
*** 44-jian *** 44-jian
*** 48-planck *** 48-planck
*** 50-kyria *** 50-kyria
**** Default **** Default
[[https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/mapping/miryoku-kle-mapping-kyria.png]] [[https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/mapping/miryoku-kle-mapping-kyria.png]]
**** Extend Thumbs **** Extend Thumbs
~MIRYOKU_MAPPING=EXTENDED_THUMBS~ ~MIRYOKU_MAPPING=EXTENDED_THUMBS~
@ -134,27 +121,20 @@ compatibility
* Keyboard Keymaps * Keyboard Keymaps
Keymap files for many keyboards included in ZMK are provided in Keymap files for many keyboards included in ZMK are provided in [[./config/][config/]].
[[./config/][config/]].
* Prebuilt Firmware * Prebuilt Firmware
Prebuilt firmware for supported keyboards can be downloaded from the repo when Prebuilt firmware can be downloaded from the repo. Log in to GitHub, visit the [[https://github.com/manna-harbour/miryoku-zmk/actions][Actions]] tab, select the appropriate workflow, select the latest successful workflow run, select the desired artifact, and unzip the downloaded zip file.
logged in. From the
[[https://github.com/manna-harbour/miryoku-zmk/actions][Actions]] tab select the
latest successful workflow run, then select the keyboard in the Artifacts
section.
* Contact * Contact
For issues with the code, including requests for any of the following, please For issues with the code, including requests for any of the following, please [[https://github.com/manna-harbour/miryoku-zmk/issues/new][create an issue]]. Pull requests are also welcome.
[[https://github.com/manna-harbour/miryoku-zmk/issues/new][create an issue]].
Pull requests are also welcome.
- Additional mapping and keyboard keymap files - Additional mapping and keyboard keymap files
- Additional mapping options (see miryoku QMK for examples) - Additional mapping configuration options (see miryoku QMK for examples)
- Populating unused keys in ~MIRYOKU_MAPPING_TAP~ (currently skipped for some mapping files) - Populating unused keys in ~MIRYOKU_MAPPING_TAP~ (currently skipped for some mapping files)
[[https://github.com/manna-harbour][https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/logos/manna-harbour-boa-32.png]] [[https://github.com/manna-harbour][https://raw.githubusercontent.com/manna-harbour/miryoku/master/data/logos/manna-harbour-boa-32.png]]