aboutsummaryrefslogtreecommitdiff
path: root/keyboards/fatotesa/readme.md
diff options
context:
space:
mode:
authorStefan Gluszek <[email protected]>2024-04-30 04:45:46 +0200
committerGitHub <[email protected]>2024-04-29 19:45:46 -0700
commitb99e09ee0ebdbd473afd2e1dc35266e453c405b2 (patch)
tree16ea0012879b47185bad8e853d90306d5a1de9e4 /keyboards/fatotesa/readme.md
parent284e29d4a1edcdd4bcaeb9a41d824d471369ceaf (diff)
downloadqmk_firmware-b99e09ee0ebdbd473afd2e1dc35266e453c405b2.tar.gz
qmk_firmware-b99e09ee0ebdbd473afd2e1dc35266e453c405b2.zip
[Keyboard] Fatotesa - custom asymmetric split keyboard (#23528)
Co-authored-by: jack <[email protected]>
Diffstat (limited to 'keyboards/fatotesa/readme.md')
-rw-r--r--keyboards/fatotesa/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/fatotesa/readme.md b/keyboards/fatotesa/readme.md
new file mode 100644
index 0000000000..a3794cfd66
--- /dev/null
+++ b/keyboards/fatotesa/readme.md
@@ -0,0 +1,25 @@
+# fatotesa
+
+![fatotesa](https://i.imgur.com/LbxQcU2.png)
+
+This is the QMK firmware for the [fat-o-tesa](https://github.com/stefangluszek/fat-o-tesa) keyboard.
+
+* Keyboard Maintainer: [Stefan Gluszek](https://github.com/stefangluszek)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make fatotesa:default
+
+Flashing example for this keyboard:
+
+ make fatotesa: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 (4,1) in the matrix and plug in the keyboard - this is somewhat unusual choice but our split halves are not symmetrical and we can't use (0,0) but instead a key that maps to the same matrix position regardless of which part is being connected to the computer and flashed.
+* **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