diff options
author | Dane Lipscombe <[email protected]> | 2023-08-15 19:06:18 +1000 |
---|---|---|
committer | GitHub <[email protected]> | 2023-08-15 10:06:18 +0100 |
commit | dbd847d4d3835ec4ab1067b535231284c5cece2d (patch) | |
tree | 00592a505b2973d573167c610d58a565be0fb496 /keyboards/chouchou/readme.md | |
parent | 31a9d2d00dc732ca29be2213dbf915d6f6ffc76d (diff) | |
download | qmk_firmware-dbd847d4d3835ec4ab1067b535231284c5cece2d.tar.gz qmk_firmware-dbd847d4d3835ec4ab1067b535231284c5cece2d.zip |
[Keyboard] Add Chouchou keyboard (#21699)
Diffstat (limited to 'keyboards/chouchou/readme.md')
-rw-r--r-- | keyboards/chouchou/readme.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/chouchou/readme.md b/keyboards/chouchou/readme.md new file mode 100644 index 0000000000..dcd0c90314 --- /dev/null +++ b/keyboards/chouchou/readme.md @@ -0,0 +1,26 @@ +# Chouchou + + + +Chouchou (Japanese for butterfly) is a minimalist unibody keyboard designed to be used with the [Taipo](https://inkeys.wiki/en/keymaps/taipo) layout. + +- [Github repo](https://github.com/dlip/chouchou) +- Keyboard Maintainer: [Dane Lipscombe](https://github.com/dlip) + +Make example for this keyboard (after setting up your build environment): + + make chouchou:default + +Flashing example for this keyboard: + + make chouchou:default:flash + +See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs). + +## Bootloader + +Enter the bootloader in 3 ways: + +* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard +* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead +* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
\ No newline at end of file |