summaryrefslogtreecommitdiffstats
path: root/keyboards/handwired/k8split/readme.md
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2020-10-25 15:23:42 +0000
committerGitHub <noreply@github.com>2020-10-25 15:23:42 +0000
commitad86894ae7d5fbb7aed697d9f576cd186bfd1c9c (patch)
treec5ffe570301b95699d93566d5b9453bda203a7ae /keyboards/handwired/k8split/readme.md
parentaf455a8368dc564df51f9657b04932956ccf580b (diff)
Rename keyboard-level readmes to lower-case (#10759)
This is the recommendation in the [PR Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it will make working with them easier in the CLI/API/etc.
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).