summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/k8split/README.md
diff options
context:
space:
mode:
authorCkat <Ckat@teknik.io>2020-05-21 23:37:09 +0000
committerGitHub <noreply@github.com>2020-05-21 16:37:09 -0700
commit53224e03d62a4d0bd7c9f7e63fd6222ec649a4fa (patch)
tree70271f5127e3a96b97c602bcb8b92b3640164949 /keyboards/handwired/k8split/README.md
parent7ef2ea3d492f07a069b0dbbb2459d6b8149ddf29 (diff)
[Keyboard] handwired/k8split (#9133)
* New Keyboard: k8split * Apply suggestions from code review * move NKRO rule to keymap scope
Diffstat (limited to 'keyboards/handwired/k8split/README.md')
-rw-r--r--keyboards/handwired/k8split/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/handwired/k8split/README.md b/keyboards/handwired/k8split/README.md
new file mode 100644
index 0000000000..01c3365abc
--- /dev/null
+++ b/keyboards/handwired/k8split/README.md
@@ -0,0 +1,21 @@
+# k8split
+![left](https://raw.githubusercontent.com/Ckath/k8split/master/k8split_left.png)
+![right](https://raw.githubusercontent.com/Ckath/k8split/master/k8split_right.png)
+
+my personal 8x6(x2) split keyboard, aiming to be a mostly normal keyboard layout with plenty of keys. see the hardware repo for more info.
+
+* Keyboard Maintainer: [Ckath](https://github.com/Ckath)
+* Hardware: https://github.com/Ckath/k8split
+
+Make example for this keyboard (after setting up your build environment):
+
+ make handwired/k8split:default
+
+Flashing (both halves are separate keyboards and the default layout is just for debugging):
+
+ # left
+ make handwired/k8split:left:flash
+ # right
+ make handwired/k8split:right: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).