diff options
Diffstat (limited to 'keyboards/ogurec/readme.md')
| -rw-r--r-- | keyboards/ogurec/readme.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/ogurec/readme.md b/keyboards/ogurec/readme.md new file mode 100644 index 000000000..3e0ae153f --- /dev/null +++ b/keyboards/ogurec/readme.md | |||
| @@ -0,0 +1,27 @@ | |||
| 1 | # ogurec | ||
| 2 | |||
| 3 |  | ||
| 4 | |||
| 5 | ogurec is a reversible 12u x 3u ortholinear keyboard that offers left-sided and right-sided PM placement. | ||
| 6 | |||
| 7 | The default ogurec keymap is for left-sided PM placement. | ||
| 8 | |||
| 9 | When flashing ogurec with the PM soldered onto the right side, follow the second example below and use: make ogure/right_pm:default | ||
| 10 | |||
| 11 | * Keyboard Maintainer: [H. Bond](https://github.com/drhigsby) | ||
| 12 | * Hardware Supported: ogurec (https://github.com/drhigsby/ogurec) | ||
| 13 | * Hardware Availability: open source 3DP case available here https://github.com/drhigsby (case creator: https://github.com/dpalka15) | ||
| 14 | |||
| 15 | Make example for this keyboard (after setting up your build environment): | ||
| 16 | |||
| 17 | make ogurec:default | ||
| 18 | make ogurec/right_pm:default | ||
| 19 | |||
| 20 | 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. | ||
| 21 | |||
| 22 | Flashing example for this keyboard: | ||
| 23 | |||
| 24 | make ogurec:default:flash | ||
| 25 | make ogurec/right_pm:default:flash | ||
| 26 | |||
| 27 | 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). | ||
