summaryrefslogtreecommitdiff
path: root/keyboards/handwired/phantagom/baragon/readme.md
diff options
context:
space:
mode:
authorDennis Kruyt <dennis@kruyt.org>2023-05-02 05:28:05 +0200
committerGitHub <noreply@github.com>2023-05-01 20:28:05 -0700
commit9b41e8168d99ded7c53b09b6cce53287e8244df3 (patch)
tree9d071001433aa6d8bf596fdf372b2c08a7bf2ea2 /keyboards/handwired/phantagom/baragon/readme.md
parente206a1684e6f31a5a41883b77b5823a99141e971 (diff)
[Keyboard] add phantagom/baragon marcopad (#20543)
Co-authored-by: Pablo Martínez <58857054+elpekenin@users.noreply.github.com> Co-authored-by: jack <0x6a73@protonmail.com> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Tom Barnes <barnestom@me.com>
Diffstat (limited to 'keyboards/handwired/phantagom/baragon/readme.md')
-rw-r--r--keyboards/handwired/phantagom/baragon/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/handwired/phantagom/baragon/readme.md b/keyboards/handwired/phantagom/baragon/readme.md
new file mode 100644
index 0000000000..e47616c0d8
--- /dev/null
+++ b/keyboards/handwired/phantagom/baragon/readme.md
@@ -0,0 +1,29 @@
+# phantagom/baragon
+
+[Baragon](https://en.wikipedia.org/wiki/Baragon) is a fictional monster, or kaiju, which first appeared in Ishirō Honda's 1965 film Frankenstein vs. Baragon.
+
+![phantagom/baragon](https://i.imgur.com/17RkGUPh.jpeg)
+
+A macro pad, 3x3 with rgb ring and rotary encoder, via compatible. Keys can be rotated, so macropad is usable at different angles.
+
+* Keyboard Maintainer: [Dennis Kruyt](https://github.com/dkruyt)
+* Project page: [baragon](https://github.com/dkruyt/mk/tree/main/baragon)
+* Hardware Supported: *RP2040-Zero*
+
+Make example for this keyboard (after setting up your build environment):
+
+ make phantagom/baragon:default
+
+Flashing example for this keyboard:
+
+ Copy the uf2 file to the rp2040
+
+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 mode 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 top of the PCB
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available