summaryrefslogtreecommitdiff
path: root/keyboards/proteus67/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/proteus67/readme.md')
-rw-r--r--keyboards/proteus67/readme.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/keyboards/proteus67/readme.md b/keyboards/proteus67/readme.md
new file mode 100644
index 0000000000..b1422b8042
--- /dev/null
+++ b/keyboards/proteus67/readme.md
@@ -0,0 +1,25 @@
+# proteus67
+
+![proteus67](https://i.imgur.com/mYhl7Jah.png)
+
+67 key ortholinear layout with rotary encoder.
+
+* Keyboard Maintainer: [James Gzowski](https://github.com/gzowski)
+* Hardware Supported: Elite-Pi or equivilent RP2040 controller with additional I/O along bottom.
+* Build Guide: [Proteus67](https://github.com/gzowski/Proteus67)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make proteus67:default
+
+Flashing example for this keyboard:
+
+ make proteus67: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
+
+* **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, if using a RP2040 press repeatidly to enter boot mode.
+* **Hold down boot loader button on MCU** Hold down the boot loader button on the MCU while plugging in the keyboard