11# My QMK keyboard layout
22
3- Based on Miryoku Layout
3+ This is a QWERTY Miryoku-inspired layout optimized for ergonomics.
4+
5+ It's a Split 3x6_3 with the outer columns dedicated to Window management shortcuts.
6+
7+ It features:
8+
9+ - Predictive Tap Hold: Faster tap/hold decisions
10+ - Home row mods
11+ - Layer-tap keys: Hold thumb keys to access layers, tap for the base key
12+ - Raw HID: Layer state communication to a companion app
13+
14+ Remember:
415
516- Don’t connect or disconnect the TRRS cable when the keyboard is powered. Always disconnect the USB cable first.
6- - Flash the firmware on both Raspberry Pi Picos.
7- - Enter the bootloader mode by holding down the BOOTSEL button while reconnecting the board into USB port.
17+ - Flash the firmware on both sides.
818
9- https://github.com/beekeeb/piantor
19+ ![ Base Layout ] ( ./data/layers/miryoku-kle-base.png )
1020
11- https://github.com/qmk/qmk_firmware/tree/master/keyboards/beekeeb/piantor
21+ ## Keyboards
22+
23+ - [ Piantor ] ( ./keyboards/beekeeb/piantor/readme.md )
24+ - [ Corne ] ( ./keyboards/crkbd/rev1/readme.md )
1225
1326## Keyboard Layers App companion
1427
@@ -33,32 +46,45 @@ Details here: https://github.com/maatthc/miryoku_qmk_app
3346- Set up QMK:
3447` cd ..; qmk setup `
3548
36- ### Install old GCC 8.3.0
37- Reduces size considerably (~ 1.5k):
49+ #### Piantor
50+ ```
51+ export KEYBOARD="beekeeb/piantor"
52+ ```
53+ #### Corne
54+
55+ ```
56+ export KEYBOARD="crkbd/rev1"
57+ ```
3858
39- ` ./install_avr_8.3.0.sh `
40- export PATH=${HOME}/avr_toolchain/bin:$PATH
59+ ##### Compile with GCC v8.3.0
60+ Generates a firmware considerably smaller (~ 1.5k):
61+
62+ ```
63+ ./install_avr_8.3.0.sh
64+ export PATH=${PWD}/avr_toolchain/bin:$PATH
65+ ```
4166
4267### Compile
43- ` qmk compile -kb beekeeb/piantor -km maat `
68+ ` qmk compile -kb $KEYBOARD -km maat `
4469
4570### Flash
46- ` qmk flash -kb beekeeb/piantor -km maat `
71+ ` qmk flash -kb $KEYBOARD -km maat `
4772
48- ### Generates the clang compile_commands.json
49- ` qmk compile --compiledb -kb crkbd/rev1 -km maat `
73+ ### Generates the Clang compile_commands.json
74+ ` qmk compile --compiledb -kb $KEYBOARD -km maat `
5075
5176### Check debug logs
5277` qmk console `
5378
5479### info
5580
56- ` qmk info -kb beekeeb/piantor -km maat `
81+ ` qmk info -kb $KEYBOARD -km maat `
5782
5883## Configuration
5984
60- - users/maat/
61- - keyboards/beekeeb/piantor/keymaps/maat/
85+ - ./users/maat/
86+ - ./keyboards/beekeeb/piantor/keymaps/maat/
87+ - ./keyboards/crkbd/rev1/keymaps/maat/
6288
6389### Typing Test
6490
@@ -67,21 +93,23 @@ https://config.qmk.fm/#/test
6793### Symbols that correspond to keycodes available in QMK.
6894https://docs.qmk.fm/keycodes
6995
70- ## Generated Layout/Layers images
96+ ## All Layers
97+
98+ Definitions (.json) files at: ./data/layers/
7199
72- Json files and images at: ./data/layers/
100+ Images generated with [ KLE NG ] ( https://editor.keyboard-tools.xyz/ )
73101
74- - ![ Base] ( ./data/layers/miryoku-kle-base.png )
102+ ![ Base] ( ./data/layers/miryoku-kle-base.png )
75103
76- - ![ Media] ( ./data/layers/miryoku-kle-media.png )
104+ ![ Media] ( ./data/layers/miryoku-kle-media.png )
77105
78- - ![ Nav] ( ./data/layers/miryoku-kle-nav.png )
106+ ![ Nav] ( ./data/layers/miryoku-kle-nav.png )
79107
80- - ![ Mouse] ( ./data/layers/miryoku-kle-mouse.png )
108+ ![ Mouse] ( ./data/layers/miryoku-kle-mouse.png )
81109
82- - ![ Symbols] ( ./data/layers/miryoku-kle-sym.png )
110+ ![ Symbols] ( ./data/layers/miryoku-kle-sym.png )
83111
84- - ![ Numbers] ( ./data/layers/miryoku-kle-num.png )
112+ ![ Numbers] ( ./data/layers/miryoku-kle-num.png )
85113
86- - ![ Fun ] ( ./data/layers/miryoku-kle-fun.png )
114+ ![ Functions ] ( ./data/layers/miryoku-kle-fun.png )
87115
0 commit comments