qmk_firmware/layouts/community/ergodox/yoruian
Ryan 415d683ea7
Remove unused `action_get_macro()` usages in user files (#11165)
2021-01-11 01:25:45 -08:00
..
90-ergodox-yoruian.conf
README
ergodox_yoruian
keymap.c
rules.mk
yoruian.h

README

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

          Snarfangel's YORUIAN for the ErgoDox EZ
          ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
DEFAULT
┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓ ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓
┃ ` │ ; │ : │ - │ / │ ( │ < ┃ ┃ > │ ) │ ^ │ * │ ~ │ Γ │ σ ┃
┠───┼───┼───┼───┼───┼───┼───┨ ┠───┼───┼───┼───┼───┼───┼───┨
┃ ⎋ │ . │ y │ o │ r │ ? │ ✦ ┃ ┃ ✦ │ j │ v │ d │ f │ w │ q ┃
┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
┃ ⎈ │ u │ i │ a │ n │ ! ├───┨ ┠───┤ m │ h │ t │ s │ c │ ⎈ ┃
┠───┼───┼───┼───┼───┼───┤ ❖ ┃ ┃ ❖ ├───┼───┼───┼───┼───┼───┨
┃ λ │ ' │ " │ , │ _ │ = │   ┃ ┃   │ k │ l │ p │ g │ b │ x ┃
┠───┼───┼───┼───┼───╆━━━┷━━━┛ ┗━━━┷━━━╅───┼───┼───┼───┼───┨
┃ ⎀ │ E │   │   │ ◆ ┃                 ┃ ◆ │   │   │ z │ ⎙ ┃
┗━━━┷━━━┷━━━┷━━━┷━━━┛                 ┗━━━┷━━━┷━━━┷━━━┷━━━┛
                    ┏━━━┯━━━┓ ┏━━━┯━━━┓
                    ┃ ⌫ │ ⌥ ┃ ┃ ⎄ │ ↹ ┃
                ┏━━━╃───┼───┨ ┠───┼───╄━━━┓
                ┃   │   │   ┃ ┃   │   │   ┃
                ┃ e │ ⇧ ├───┨ ┠───┤ ⏎ │ ␣ ┃
                ┃   │   │   ┃ ┃   │   │   ┃
                ┗━━━┷━━━┷━━━┛ ┗━━━┷━━━┷━━━┛
SHIFTED
┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓ ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓
┃ 9 │ 7 │ 5 │ 3 │ 1 │ [ │ { ┃ ┃ } │ ] │ 0 │ 2 │ 4 │ 6 │ 8 ┃
┠───┼───┼───┼───┼───┼───┼───┨ ┠───┼───┼───┼───┼───┼───┼───┨
┃   │ * │ Y │ O │ R │ \ │   ┃ ┃   │ J │ V │ D │ F │ W │ Q ┃
┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
┃   │ U │ I │ A │ N │ | ├───┨ ┠───┤ M │ H │ T │ S │ C │   ┃
┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
┃   │ # │ $ │ @ │ & │ + │   ┃ ┃   │ K │ L │ P │ G │ B │ X ┃
┠───┼───┼───┼───┼───╆━━━┷━━━┛ ┗━━━┷━━━╅───┼───┼───┼───┼───┨
┃   │   │   │   │   ┃                 ┃   │   │   │ Z │   ┃
┗━━━┷━━━┷━━━┷━━━┷━━━┛                 ┗━━━┷━━━┷━━━┷━━━┷━━━┛
                    ┏━━━┯━━━┓ ┏━━━┯━━━┓
                    ┃   │   ┃ ┃   │   ┃
                ┏━━━╃───┼───┨ ┠───┼───╄━━━┓
                ┃   │   │   ┃ ┃   │   │   ┃
                ┃   │   ├───┨ ┠───┤   │   ┃
                ┃   │   │   ┃ ┃   │   │   ┃
                ┗━━━┷━━━┷━━━┛ ┗━━━┷━━━┷━━━┛
λ LAYER
┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓ ┏━━━┯━━━┯━━━┯━━━┯━━━┯━━━┯━━━┓
┃   │   │   │   │   │   │   ┃ ┃   │   │ ⑤ │ ⑥ │ ⑦ │ ⑧ │ ⑨ ┃
┠───┼───┼───┼───┼───┼───┼───┨ ┠───┼───┼───┼───┼───┼───┼───┨
┃   │   │   │   │   │   │   ┃ ┃   │   │ ① │ ② │ ③ │ ④ │ ⑩ ┃
┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
┃   │   │   │   │   │   ├───┨ ┠───┤ ⎉ │ ← │ ↓ │ ↑ │ → │ ⑪ ┃
┠───┼───┼───┼───┼───┼───┤   ┃ ┃   ├───┼───┼───┼───┼───┼───┨
┃ λ │   │   │   │   │   │   ┃ ┃   │   │ ⇱ │ ⎘ │ ⎗ │ ⇲ │ ⑫ ┃
┠───┼───┼───┼───┼───╆━━━┷━━━┛ ┗━━━┷━━━╅───┼───┼───┼───┼───┨
┃   │   │   │   │   ┃                 ┃   │   │   │   │   ┃
┗━━━┷━━━┷━━━┷━━━┷━━━┛                 ┗━━━┷━━━┷━━━┷━━━┷━━━┛
                    ┏━━━┯━━━┓ ┏━━━┯━━━┓
                    ┃   │   ┃ ┃   │   ┃
                ┏━━━╃───┼───┨ ┠───┼───╄━━━┓
                ┃   │   │   ┃ ┃   │   │   ┃
                ┃   │   ├───┨ ┠───┤   │   ┃
                ┃   │   │   ┃ ┃   │   │   ┃
                ┗━━━┷━━━┷━━━┛ ┗━━━┷━━━┷━━━┛

Installation (X only)
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
   1. Build and flash firmware as usual

   2. sudo make install-xorg-configuration

   3. Restart X

Features
‾‾‾‾‾‾‾‾
   • E on the thumb

   • Emacs-friendly

   • Symmetric control keys for finger wear levelling

   • Greek and subscript dead keys

   • Compose key for arbitrary Unicode input via ~/.XCompose

Don't Cares
‾‾‾‾‾‾‾‾‾‾‾
   • Easy migration from QWERTY

   • Compatbility with non-XKB systems

   • Mouse emulation

   • Media keys

Acknowledgements
‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
Snarfangel, for designing the layout.

The GNU FreeFont project and Steve White, for adding new keyboard
symbols.

Xah Lee, for http://xahlee.info/comp/unicode_computing_symbols.html

Colophon
‾‾‾‾‾‾‾‾
This file is best-viewed with an SVN version of GNU FreeFont Mono.