summaryrefslogtreecommitdiff
path: root/keyboards/quark/readme.md
diff options
context:
space:
mode:
authornpspears <40127181+npspears@users.noreply.github.com>2020-12-31 09:00:08 -0600
committerGitHub <noreply@github.com>2020-12-31 10:00:08 -0500
commit4ef4347543da5dcd93f342b2728840c6e0407906 (patch)
treea040904f77e7551d22eb98d984d211480b127396 /keyboards/quark/readme.md
parent028d2c91dc5175904ee57917e2a90028569e0f8f (diff)
Quark PCB for Planck/Preonic (#11206)
* Quark PCB for Planck/Preonic Quark provides alternate bottom row layouts for both the OLKB Planck and Preonic * Rename rules.mk.txt to rules.mk * added Tapping Toggle removed tapping toggle from keymap level * Update info.json took out } as requested * update config.h added GPL2+ license and #pragma once * update info.json again cleaned up syntax * Apply suggestions from code review Co-authored-by: Drashna Jaelre <drashna@live.com> * update config.h added GPL2+ License * Update info.json - and again fixed it - oops Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/quark/readme.md')
-rw-r--r--keyboards/quark/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/quark/readme.md b/keyboards/quark/readme.md
new file mode 100644
index 0000000000..def04f59f3
--- /dev/null
+++ b/keyboards/quark/readme.md
@@ -0,0 +1,15 @@
+# Quark
+
+![Quark](https://i.imgur.com/WcvKyf4.jpg)
+
+The Quark PCB is a modified layout for the Planck by OLKB. It's similar to a Planck, but the bottom row was designed to be more useable-larger than 1u keys.
+
+Keyboard Maintainer: [Nasp](https://github.com/npspears)
+Hardware Supported: Planck
+Hardware Availability: https://forms.gle/ZpGtQjBNtsbuSV767
+
+Make example for this keyboard (after setting up your build environment):
+
+ make quark:default
+
+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).