Merge pull request #2 from maatthc/corne

feat: Add Corne

Author: maatthc

.gitignore

@@ -14,3 +14,7 @@
 compile_commands.json
 .clangd/
 .cache/
+
+# GCC
+avr_toolchain/
+avr_toolchain_build/

README.md

@@ -1,64 +1,108 @@
 #   My QMK keyboard layout
 
-Based on Miryoku Layout
+This is a QWERTY Miryoku-inspired layout optimized for ergonomics.
+
+It's a Split 3x6_3 with the outer columns dedicated to Window management shortcuts.
+
+It features:
+
+- Predictive Tap Hold: Faster tap/hold decisions
+- Home row mods 
+- Layer-tap keys: Hold thumb keys to access layers, tap for the base key
+- Raw HID: Layer state communication to a companion app
+
+Remember:
 
 - Don’t connect or disconnect the TRRS cable when the keyboard is powered. Always disconnect the USB cable first.
-- Flash the firmware on both Raspberry Pi Picos.
-- Enter the bootloader mode by holding down the BOOTSEL button while reconnecting the board into USB port.
+- Flash the firmware on both sides.
 
-https://github.com/beekeeb/piantor
+![Base Layout](./data/layers/miryoku-kle-base.png)
 
-https://github.com/qmk/qmk_firmware/tree/master/keyboards/beekeeb/piantor
+## Keyboards
+
+- [ Piantor ](./keyboards/beekeeb/piantor/readme.md)
+- [ Corne ](./keyboards/crkbd/rev1/readme.md)
 
 ## Keyboard Layers App companion
 
 Display the selected keyboard layer layout on screen to assist your to memorize the key's locations.
 
 It allows you to display the layout in a remote screen, so you can use a tablet or similar to save space on your main screen.
 
-Details here: https://github.com/maatthc/miryoku_qmk_app
+Details here: https://github.com/maatthc/keyboard_layers_app_companion
 
 ## Compile and Flash
 
 ### Install and setup
 - Install QMK:
-`python3 -m pip install qmk`
+```
+python3 -m pip install qmk
+```
 
 - Initialize the sub-modules:
-`git submodule update --init --recursive`
+```
+git submodule update --init --recursive
+```
 
 - Set this folder as an userspace:
-`qmk config user.overlay_dir="$(realpath qmk_userspace)"`
+```
+qmk config user.overlay_dir="$(realpath qmk_userspace)"
+```
 
 - Set up QMK:
-`cd ..; qmk setup`
+```
+cd ..; qmk setup
+```
+
+#### Piantor
+```
+export KEYBOARD="beekeeb/piantor"
+```
+#### Corne 
 
-### Install old GCC 8.3.0
-Reduces size considerably (~1.5k):
+```
+export KEYBOARD="crkbd/rev1"
+```
 
-`./install_avr_8.3.0.sh`
-export PATH=${HOME}/avr_toolchain/bin:$PATH
+##### Compile with GCC v8.3.0
+Generates a firmware considerably smaller (~1.5k):
+
+```
+./install_avr_8.3.0.sh
+export PATH=${PWD}/avr_toolchain/bin:$PATH
+```
 
 ### Compile
-`qmk compile -kb beekeeb/piantor -km maat`
+```
+qmk compile -kb $KEYBOARD -km maat
+```
 
 ### Flash
-`qmk flash -kb beekeeb/piantor -km maat`
+```
+qmk flash -kb $KEYBOARD -km maat
+```
 
-### Generates the clang compile_commands.json
-`qmk compile --compiledb -kb crkbd/rev1 -km maat`
+### Generates the Clang compile_commands.json
+```
+qmk compile --compiledb -kb $KEYBOARD -km maat
+```
 
 ### Check debug logs
-`qmk console`
+```
+qmk console
+```
 
 ### info
 
-`qmk info -kb beekeeb/piantor -km maat`
+```
+qmk info -kb $KEYBOARD -km maat
+```
 
 ## Configuration
 
-- users/maat/
-- keyboards/beekeeb/piantor/keymaps/maat/
+- ./users/maat/
+- ./keyboards/beekeeb/piantor/keymaps/maat/
+- ./keyboards/crkbd/rev1/keymaps/maat/
 
 ### Typing Test
 
@@ -67,21 +111,23 @@ https://config.qmk.fm/#/test
 ### Symbols that correspond to keycodes available in QMK.
 https://docs.qmk.fm/keycodes
 
-## Generated Layout/Layers images
+## All Layers
+
+Definitions (.json) files at: ./data/layers/
 
-Json files and images at: ./data/layers/
+Images generated with [KLE NG](https://editor.keyboard-tools.xyz/)
 
-- ![Base](./data/layers/miryoku-kle-base.png)
+![Base](./data/layers/miryoku-kle-base.png)
 
-- ![Media](./data/layers/miryoku-kle-media.png)
+![Media](./data/layers/miryoku-kle-media.png)
 
-- ![Nav](./data/layers/miryoku-kle-nav.png)
+![Nav](./data/layers/miryoku-kle-nav.png)
 
-- ![Mouse](./data/layers/miryoku-kle-mouse.png)
+![Mouse](./data/layers/miryoku-kle-mouse.png)
 
-- ![Symbols](./data/layers/miryoku-kle-sym.png)
+![Symbols](./data/layers/miryoku-kle-sym.png)
 
-- ![Numbers](./data/layers/miryoku-kle-num.png)
+![Numbers](./data/layers/miryoku-kle-num.png)
 
-- ![Fun](./data/layers/miryoku-kle-fun.png)
+![Functions](./data/layers/miryoku-kle-fun.png)