summaryrefslogtreecommitdiff
path: root/keyboards/hillside/46/readme.md
diff options
context:
space:
mode:
authormmccoyd <mmccoyd@users.noreply.github.com>2022-11-20 00:50:09 -0800
committerGitHub <noreply@github.com>2022-11-20 00:50:09 -0800
commit543a863766192eab626492ec4f48641743ffc797 (patch)
tree8be77287c17bfdc6bd5d78a866af2b3ee43cd492 /keyboards/hillside/46/readme.md
parent66e4add9725bac525f9ca6e9e44ccbab2ded5412 (diff)
[Keyboard] Move Hillside out of handwired (#18751)
Co-authored-by: mmccoyd <mmccoyd@cs.berkley.edu>
Diffstat (limited to 'keyboards/hillside/46/readme.md')
-rw-r--r--keyboards/hillside/46/readme.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/keyboards/hillside/46/readme.md b/keyboards/hillside/46/readme.md
new file mode 100644
index 0000000000..4a02982843
--- /dev/null
+++ b/keyboards/hillside/46/readme.md
@@ -0,0 +1,29 @@
+# Hillside 46
+
+![hillside](https://imgur.com/VFA9E4Yh.png)
+
+[Hillside 46](https://github.com/mmccoyd/hillside)
+ is a split ergonomic keyboard with 3x6+5 choc-spaced keys,
+ splayed ring and pinkie columns, aggressive column stagger,
+ a longer thumb arc and a breakoff outer-pinkie column.
+
+* Keyboard Maintainer: [Michael McCoyd](https://github.com/mmccoyd)
+* Hardware Supported: ProMicro/Elite-C and compatible
+* Hardware Availability: https://github.com/mmccoyd/hillside
+
+Make example for this keyboard (after setting up your build environment):
+
+ make hillside/46/0_1:default
+
+Flashing example for this keyboard:
+
+ make hillside/46/0_1:default:flash
+
+## Bootloader
+
+Enter the bootloader by either:
+
+* **Physical reset button**: Briefly press the button on the front of the PCB.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
+
+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).