summaryrefslogtreecommitdiffstats
path: root/keyboards/chouchou/readme.md
diff options
context:
space:
mode:
authorzvecr <git@zvecr.com>2023-08-15 10:49:57 +0100
committerzvecr <git@zvecr.com>2023-08-15 10:49:57 +0100
commit3ece80f73f781a719ea6665af1d01b99922388e9 (patch)
tree3a387461b106415b8524b219da4053a680d9c9f1 /keyboards/chouchou/readme.md
parentf38ccaa598f83aefc7821d5491970a31de4c6acc (diff)
parentdbd847d4d3835ec4ab1067b535231284c5cece2d (diff)
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'keyboards/chouchou/readme.md')
-rw-r--r--keyboards/chouchou/readme.md26
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](https://i.imgur.com/BYk2n5Ch.jpeg)
+
+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