summaryrefslogtreecommitdiff
path: root/keyboards/kbdcraft/adam64/readme.md
diff options
context:
space:
mode:
authoradophoxia <100170946+adophoxia@users.noreply.github.com>2023-04-23 12:07:35 -0700
committerGitHub <noreply@github.com>2023-04-23 13:07:35 -0600
commit713427c086ec6449f53f4a3b60d024d4f8595d51 (patch)
tree7ca6d15f57c3f7ad36de2383ec91e3c31f07b600 /keyboards/kbdcraft/adam64/readme.md
parente1afcda1c05f1004f7a19597d06a73e0bb73150a (diff)
Add KBDCraft Adam64 Lego board (#20503)
Co-authored-by: Less/Rikki <86894501+lesshonor@users.noreply.github.com> Co-authored-by: jack <0x6a73@protonmail.com>
Diffstat (limited to 'keyboards/kbdcraft/adam64/readme.md')
-rw-r--r--keyboards/kbdcraft/adam64/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/kbdcraft/adam64/readme.md b/keyboards/kbdcraft/adam64/readme.md
new file mode 100644
index 0000000000..25550aff44
--- /dev/null
+++ b/keyboards/kbdcraft/adam64/readme.md
@@ -0,0 +1,27 @@
+# KBDCraft Adam64
+
+![Adam64](https://i.imgur.com/6m2yyTUh.jpg)
+
+A custom 64-key mechanical keyboard comprised of Legos.
+
+* Keyboard Maintainer: The QMK Community
+* Hardware Supported: STM32F401
+* Hardware Availability: https://kbdcraft.store/products/adam
+
+Make example for this keyboard (after setting up your build environment):
+
+ make kbdcraft/adam64:default
+
+Flashing example for this keyboard:
+
+ make kbdcraft/adam64: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