summaryrefslogtreecommitdiff
path: root/keyboards/adpenrose/obi/readme.md
diff options
context:
space:
mode:
authorInigoGutierrez <inigogf.95@gmail.com>2022-09-29 11:25:42 +0200
committerInigoGutierrez <inigogf.95@gmail.com>2022-09-29 11:25:42 +0200
commite477fc45079e29fe2bee92f3a3b1c11346888ebc (patch)
tree56bacbd498d01e8294c814a6fa75c8e9e77cc050 /keyboards/adpenrose/obi/readme.md
parent6afdd9d74da250e47ac64d6690bd19d037045e99 (diff)
parenteb55551e2d764ac48c48e02165589ab11f4c8005 (diff)
downloadqmk_firmware-e477fc45079e29fe2bee92f3a3b1c11346888ebc.tar.gz
qmk_firmware-e477fc45079e29fe2bee92f3a3b1c11346888ebc.zip
Merge branch 'master' into taamastaamas
Diffstat (limited to 'keyboards/adpenrose/obi/readme.md')
-rw-r--r--keyboards/adpenrose/obi/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/adpenrose/obi/readme.md b/keyboards/adpenrose/obi/readme.md
new file mode 100644
index 0000000000..59c0b796ae
--- /dev/null
+++ b/keyboards/adpenrose/obi/readme.md
@@ -0,0 +1,29 @@
+# Obi
+
+![obi](https://i.imgur.com/btQPol1h.png)
+
+A 40% keyboard inspired by the TMOv2 and Nightmare boards.
+
+# General info
+
+* Keyboard Maintainer: [Arturo Avila](https://github.com/ADPenrose)
+* Hardware Supported: Obi v1 PCB
+* Hardware Availability: [Arturo Avila](https://github.com/ADPenrose)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make adpenrose/obi:default
+
+Flashing example for this keyboard:
+
+ make adpenrose/obi: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