summaryrefslogtreecommitdiff
path: root/keyboards/handwired/phantagom/varan/readme.md
diff options
context:
space:
mode:
authorDennis Kruyt <dennis@kruyt.org>2023-05-02 05:20:02 +0200
committerGitHub <noreply@github.com>2023-05-01 20:20:02 -0700
commite206a1684e6f31a5a41883b77b5823a99141e971 (patch)
treed3f4ae50dbd8153c69d851bb28cb52ecfada5162 /keyboards/handwired/phantagom/varan/readme.md
parent62a90945c72c66304bac0046d024f25593564b43 (diff)
[Keyboard] add phantagom/varan rgb numpad (#20587)
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/handwired/phantagom/varan/readme.md')
-rw-r--r--keyboards/handwired/phantagom/varan/readme.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/keyboards/handwired/phantagom/varan/readme.md b/keyboards/handwired/phantagom/varan/readme.md
new file mode 100644
index 0000000000..a7aaa16403
--- /dev/null
+++ b/keyboards/handwired/phantagom/varan/readme.md
@@ -0,0 +1,30 @@
+# phantagom/varan
+
+[Varan](https://en.wikipedia.org/wiki/Varan) is a fictional monster, or kaiju, which first appeared in the 1958 film Varan the Unbelievable
+
+![phantagom/varan](https://i.imgur.com/EuGAMyeh.jpeg)
+![phantagom/varan](https://i.imgur.com/zO2ju9Ah.jpeg)
+
+A numpad with RGB strip based on a RP2040 controller.
+
+* Keyboard Maintainer: [Dennis Kruyt](https://github.com/dkruyt)
+* Project page: [varan](https://github.com/dkruyt/mk/tree/main/varan)
+* Hardware Supported: *RP2040-Zero*
+
+Make example for this keyboard (after setting up your build environment):
+
+ make phantagom/varan:default
+
+Flashing example for this keyboard:
+
+ make phantagom/varan: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