summaryrefslogtreecommitdiff
path: root/keyboards/janus/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/janus/readme.md')
-rw-r--r--keyboards/janus/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/janus/readme.md b/keyboards/janus/readme.md
new file mode 100644
index 0000000000..aa9e65cdc4
--- /dev/null
+++ b/keyboards/janus/readme.md
@@ -0,0 +1,27 @@
+# Janus
+
+![Janus](https://i.imgur.com/7Lzhafeh.jpg)
+
+A 34-key split ortholinear keyboard, powered by two Seeed XIAO RP2040.
+
+* Keyboard Maintainer: [Steven Karrmann](https://github.com/skarrmann)
+* Hardware Supported: Janus PCBs, Seeed XIAO RP2040
+* Hardware Availability: [Janus GitHub repository](https://github.com/skarrmann/janus)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make janus:default
+
+Flashing example for this keyboard:
+
+ make janus: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 top left key on the left half, or top right key on the right half, and then plug in the USB cable on that keyboard half.
+* **Physical reset button**: Double tap the reset button on the XIAO RP2040.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.