summaryrefslogtreecommitdiff
path: root/keyboards/hub20/readme.md
diff options
context:
space:
mode:
authorJosh Johnson <josh@joshajohnson.com>2021-01-14 17:46:07 +1100
committerGitHub <noreply@github.com>2021-01-13 22:46:07 -0800
commit5dfb6459df31ce1ca7dcbe57587733995a33de66 (patch)
treedc58645801993f7ed02bb828d6c03261c7971213 /keyboards/hub20/readme.md
parentd97d4794e050f2b7397e1ff586d91cdfb3c7d02b (diff)
[Keyboard] Add Hub20 keyboard (#11497)
* add Hub20 support * Keymap formatting cleanup Co-authored-by: Ryan <fauxpark@gmail.com> * Delete bootloader_defs.h as no longer required * Correct make / flashing example Co-authored-by: Ryan <fauxpark@gmail.com> * Update rules.mk Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/hub20/readme.md')
-rwxr-xr-xkeyboards/hub20/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/hub20/readme.md b/keyboards/hub20/readme.md
new file mode 100755
index 0000000000..e2477b012d
--- /dev/null
+++ b/keyboards/hub20/readme.md
@@ -0,0 +1,19 @@
+# Hub20
+
+Hub20 is a 20 key macro pad with an inbuilt USB 2.0 hub and dual rotary encoders. It can be configured to be a left / right hand numberpad, along with a 4x5 1u layout.
+
+For more information regarding the keyboard, please visit the [Hub20 Website](https://www.joshajohnson.com/hub20) or [GitHub Repo](https://github.com/joshajohnson/Hub20).
+
+* Keyboard Maintainer: [Josh Johnson](https://github.com/joshajohnson)
+* Hardware Supported: Hub20 PCB (STM32F072)
+* Hardware Availability: [Josh Johnson](https://www.joshajohnson.com/hub20)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make hub20:default
+
+Flashing example for this keyboard:
+
+ make hub20: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).