miryoku

Miryoku is an ergonomic, minimal, orthogonal, and universal keyboard layout.

2,580

128

2,580

View on GitHub

Top Related Projects

kmk_firmware

1,376

Clackety Keyboards Powered by Python

Quick Overview

Miryoku is a minimal and ergonomic keyboard layout and firmware designed for small keyboards, particularly those with 36 to 42 keys. It focuses on providing a comfortable and efficient typing experience while maintaining compatibility across various keyboard firmware and layouts.

Pros

Highly ergonomic design optimized for comfort and efficiency
Versatile and adaptable to different keyboard sizes and layouts
Extensive documentation and configuration options
Active community support and regular updates

Cons

Steep learning curve for users accustomed to traditional keyboard layouts
May require significant time investment to achieve proficiency
Limited compatibility with some specialized software or gaming setups
Potential initial reduction in typing speed during the adaptation period

Getting Started

To get started with Miryoku:

Visit the Miryoku GitHub repository
Review the documentation in the README and wiki
Choose your preferred keyboard firmware (QMK, ZMK, or KMK)
Follow the installation instructions for your chosen firmware
Customize the layout using the provided configuration files
Flash the firmware to your keyboard

For example, to use Miryoku with QMK firmware:

git clone https://github.com/qmk/qmk_firmware.git
cd qmk_firmware
git clone https://github.com/manna-harbour/miryoku.git keyboards/miryoku
make miryoku:default

After flashing, practice with the new layout using online typing tutors or by gradually incorporating it into your daily workflow. Remember that it may take several weeks to fully adapt to the new layout and regain your original typing speed.

Competitor Comparisons

kmk_firmware

1,376

Clackety Keyboards Powered by Python

Pros of kmk_firmware

Written in CircuitPython, making it more accessible for beginners and easier to modify
Supports a wider range of keyboards and microcontrollers
More extensive documentation and community support

Cons of kmk_firmware

Generally slower performance compared to C-based firmware like QMK
Limited advanced features compared to more established firmware options
Larger firmware size due to Python overhead

Code Comparison

kmk_firmware:

from kmk.kmk_keyboard import KMKKeyboard
from kmk.keys import KC

keyboard = KMKKeyboard()
keyboard.keymap = [
    [KC.A, KC.B, KC.C]
]

Miryoku:

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    [0] = LAYOUT(
        KC_Q,    KC_W,    KC_E
    )
};

Summary

kmk_firmware offers a more accessible and flexible approach to keyboard firmware, written in CircuitPython. It supports a wider range of hardware and has better documentation. However, it may have slower performance and limited advanced features compared to C-based firmware like QMK, which Miryoku is based on. Miryoku, on the other hand, focuses on providing an ergonomic and efficient keymap layout that can be implemented across various keyboard firmware, including QMK and ZMK.

zmk

2,615

ZMK Firmware Repository

Pros of ZMK

Broader support for various keyboard hardware and wireless protocols
More active development and larger community support
Built-in support for advanced features like combos and macros

Cons of ZMK

Steeper learning curve for configuration and customization
Less focus on ergonomic layouts and minimalist design principles

Code Comparison

Miryoku (keymap configuration):

#define MIRYOKU_LAYER_BASE \
KC_Q,    KC_W,    KC_F,    KC_P,    KC_B,    KC_J,    KC_L,    KC_U,    KC_Y,    KC_QUOT, \
KC_A,    KC_R,    KC_S,    KC_T,    KC_G,    KC_M,    KC_N,    KC_E,    KC_I,    KC_O,    \
KC_Z,    KC_X,    KC_C,    KC_D,    KC_V,    KC_K,    KC_H,    KC_COMM, KC_DOT,  KC_SLSH

ZMK (keymap configuration):

/ {
    keymap {
        compatible = "zmk,keymap";
        default_layer {
            bindings = <
                &kp Q &kp W &kp F &kp P &kp B   &kp J &kp L  &kp U     &kp Y   &kp QUOT
                &kp A &kp R &kp S &kp T &kp G   &kp M &kp N  &kp E     &kp I   &kp O
                &kp Z &kp X &kp C &kp D &kp V   &kp K &kp H  &kp COMMA &kp DOT &kp FSLH
            >;
        };
    };
};