summaryrefslogtreecommitdiff
path: root/keyboards/hineybush/ibis/readme.md
diff options
context:
space:
mode:
authorJosh Hinnebusch <joshhinnebusch@gmail.com>2022-05-05 06:31:52 -0400
committerGitHub <noreply@github.com>2022-05-05 11:31:52 +0100
commit890dfebe8ddb971117d48031e4317d5387447b35 (patch)
treefedc3c0c9e00498aa3101fe0d02f6e4fcb21542b /keyboards/hineybush/ibis/readme.md
parent3fbf9dc2902d53940a1cb41d473dd63034f70839 (diff)
Add ibis PCB (#17001)
* initial ibis commit * updates etc * layout updates to fix mismatched keys * Apply suggestions from code review Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/hineybush/ibis/info.json Co-authored-by: Joel Challis <git@zvecr.com> * Update keyboards/hineybush/ibis/readme.md Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/hineybush/ibis/readme.md')
-rw-r--r--keyboards/hineybush/ibis/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/hineybush/ibis/readme.md b/keyboards/hineybush/ibis/readme.md
new file mode 100644
index 0000000000..0c345e7c81
--- /dev/null
+++ b/keyboards/hineybush/ibis/readme.md
@@ -0,0 +1,27 @@
+# hineybush/ibis
+
+![hineybush/ibis](https://i.imgur.com/TaCryDrh.png)
+
+Duck Blackbird-layout PCB for the ibis keyboard.
+
+* Keyboard Maintainer: [Josh Hinnebusch](https://github.com/hineybush)
+* Hardware Supported: ibis
+* Hardware Availability: hiney.cc
+
+Make example for this keyboard (after setting up your build environment):
+
+ make hineybush/ibis:default
+
+Flashing example for this keyboard:
+
+ make hineybush/ibis: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 `RESET` if it is available