summaryrefslogtreecommitdiff
path: root/keyboards/joshajohnson/hub16/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/joshajohnson/hub16/readme.md')
-rwxr-xr-xkeyboards/joshajohnson/hub16/readme.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/keyboards/joshajohnson/hub16/readme.md b/keyboards/joshajohnson/hub16/readme.md
new file mode 100755
index 0000000000..9735079e24
--- /dev/null
+++ b/keyboards/joshajohnson/hub16/readme.md
@@ -0,0 +1,24 @@
+# Hub16
+
+Hub16 is a 16 Key Macro Pad with an inbuilt USB 2.0 hub and dual rotary encoders.
+
+For more information regarding the keyboard, please visit the [Hub16 Website](https://www.joshajohnson.com/hub16-keyboard/) or [GitHub Repo](https://github.com/joshajohnson/Hub16).
+
+* Keyboard Maintainer: [Josh Johnson](https://github.com/joshajohnson)
+* Hardware Supported: Hub16 PCB (atmega32u4)
+* Hardware Availability: [Josh Johnson](https://www.joshajohnson.com/hub16-keyboard/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make joshajohnson/hub16:default
+
+Flashing example for this keyboard:
+
+ make joshajohnson/hub16:default:flash
+
+To reset the board into bootloader mode, do one of the following:
+
+* Press the reset switch between the center two USB-C ports while the board is plugged in
+* Hold the top left key while connecting the USB cable (also erases persistent settings)
+
+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).