summaryrefslogtreecommitdiff
path: root/keyboards/keaboard/readme.md
diff options
context:
space:
mode:
authorKeith Wade <keawade@protonmail.com>2023-02-14 02:13:27 -0500
committerGitHub <noreply@github.com>2023-02-14 00:13:27 -0700
commit999200c05a376638b0c9e6f383c9e0e0aef69a34 (patch)
tree1cae50345e0b41383a53eacd12007ac95ed8bf7b /keyboards/keaboard/readme.md
parent7a099b7ea5b7c38d4ca781354533b3962750e2b7 (diff)
Add keaboard keyboard (#19816)
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/keaboard/readme.md')
-rw-r--r--keyboards/keaboard/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/keaboard/readme.md b/keyboards/keaboard/readme.md
new file mode 100644
index 0000000000..71473211ed
--- /dev/null
+++ b/keyboards/keaboard/readme.md
@@ -0,0 +1,21 @@
+# keaboard
+
+A split columnular stagger 4x6 keyboard with 3 thumb keys designed by [Keith Wade](https://github.com/keawade). [More info on the GitHub Repo](https://github.com/keawade/keaboard).
+
+* Keyboard Maintainer: [Keith Wade](https://github.com/keawade)
+* Hardware Supported: Pro Micro and clones
+* Hardware Availability: Open source. You can order your own from a PCB manufacturer.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make keaboard/rev1:default
+
+Flashing example for this keyboard:
+
+ make keaboard/rev1: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 by holding tapping reset button on the top edge of the board. \ No newline at end of file