summaryrefslogtreecommitdiff
path: root/keyboards/ogurec/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ogurec/readme.md')
-rw-r--r--keyboards/ogurec/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/ogurec/readme.md b/keyboards/ogurec/readme.md
new file mode 100644
index 0000000000..3e0ae153fa
--- /dev/null
+++ b/keyboards/ogurec/readme.md
@@ -0,0 +1,27 @@
+# ogurec
+
+![ogurec](https://i.imgur.com/OJ5UnXT.png)
+
+ogurec is a reversible 12u x 3u ortholinear keyboard that offers left-sided and right-sided PM placement.
+
+The default ogurec keymap is for left-sided PM placement.
+
+When flashing ogurec with the PM soldered onto the right side, follow the second example below and use: make ogure/right_pm:default
+
+* Keyboard Maintainer: [H. Bond](https://github.com/drhigsby)
+* Hardware Supported: ogurec (https://github.com/drhigsby/ogurec)
+* Hardware Availability: open source 3DP case available here https://github.com/drhigsby (case creator: https://github.com/dpalka15)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make ogurec:default
+ make ogurec/right_pm:default
+
+To place the keyboard into bootloader mode, solder a reset switch onto the PCB and press it OR short the GND and RST pins on the pro micro.
+
+Flashing example for this keyboard:
+
+ make ogurec:default:flash
+ make ogurec/right_pm: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).