summaryrefslogtreecommitdiff
path: root/keyboards/ramonimbao/squishytkl/readme.md
diff options
context:
space:
mode:
authorRamon Imbao <ramonimbao@gmail.com>2021-06-24 10:53:38 +0800
committerGitHub <noreply@github.com>2021-06-24 12:53:38 +1000
commit02fcb1069ac034d593e02484604ddc0c2ebc2dc2 (patch)
treeaf0975a4d55ee47e48c90980524db9248935d618 /keyboards/ramonimbao/squishytkl/readme.md
parent3cc037d8d86a148a8a61e594ad87766f9d0ddbd5 (diff)
Add the SquishyTKL and SquishyFRL (#12764)
* Add SquishyTKL * Add SquishyTKL-FRL * Adjust readme.md and info.json * Add JIS support for SquishyTKL * Fix JIS layout macro * Fix via layout and keymap * Migrate SquishyTKL to STM32duino bootloader * Make chibios conf files generic * Change TKL via keymap to match number of layers * Apply chibios changes to FRL as well * Adjust README regarding flashing with dfu-util * Add license and header guard
Diffstat (limited to 'keyboards/ramonimbao/squishytkl/readme.md')
-rw-r--r--keyboards/ramonimbao/squishytkl/readme.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/keyboards/ramonimbao/squishytkl/readme.md b/keyboards/ramonimbao/squishytkl/readme.md
new file mode 100644
index 0000000000..29655d29d6
--- /dev/null
+++ b/keyboards/ramonimbao/squishytkl/readme.md
@@ -0,0 +1,18 @@
+# SquishyTKL
+
+![SquishyTKL](https://i.imgur.com/b04ooQ7l.png)
+
+A stacked acrylic o-ring gasket mounted TKL-sized keyboard with a twist!
+
+* Keyboard Maintainer: [Ramon Imbao](https://github.com/ramonimbao)
+* Hardware Supported: STM32F103RB
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ramonimbao/squishytkl:via
+
+Flashing example for this keyboard:
+
+ dfu-util -d 1eaf:0003 -a 2 -D path/to/ramonimbao_squishytkl_via.bin
+
+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).