summaryrefslogtreecommitdiffstats
path: root/keyboards/jels/boaty/readme.md
diff options
context:
space:
mode:
authorjels <66403163+Jels02@users.noreply.github.com>2022-11-20 05:43:59 +1000
committerGitHub <noreply@github.com>2022-11-19 11:43:59 -0800
commite16540795751c744a957ed3774eec99e587fd8db (patch)
tree0574a161d4ebad7e627059a199d3df1c2421d60f /keyboards/jels/boaty/readme.md
parent0bf72e4fe52c7458a0c1376647af2aa53901f6ee (diff)
[Keyboard] Add Boaty (#17378)
Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Jels02 <joah@Joah-Big-PC.localdomain>
Diffstat (limited to 'keyboards/jels/boaty/readme.md')
-rw-r--r--keyboards/jels/boaty/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/jels/boaty/readme.md b/keyboards/jels/boaty/readme.md
new file mode 100644
index 0000000000..d5084b1098
--- /dev/null
+++ b/keyboards/jels/boaty/readme.md
@@ -0,0 +1,27 @@
+# Boaty
+
+![Boaty](https://i.imgur.com/6LEaYxSh.jpg)
+
+* Keyboard Maintainer: [jels](https://github.com/JoahNelson)
+* Hardware Supported: Boaty
+* Hardware Availabililty: Limited Group buy from: [jels](https://jels.au)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make jels/boaty:default
+
+Flashing example for this keyboard:
+
+ make jels/boaty: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 leftmost key (ESC) and plug in the keyboard
+* **USBASPLoader**: Press down the BOOT switch and plug in the keyboard
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
+
+* **Exit Bootloader**: To exit the bootloader, press the RESET switch (Left of BOOT).