summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-04-08 19:10:14 -0700
committerJack Humbert <jack.humb@gmail.com>2018-04-08 22:10:14 -0400
commit885f06c6cf3db547533aac406686a4b3e4fb5c80 (patch)
tree8c79bbd5deab35ed059f44be9bb6f1f48b7ee0cc
parenta33c0949e01b457bb8abc0fead2060d6bf554899 (diff)
Add readme for "major" keyboards to eliminate more QMK Configurator errors (#2718)
* add readme to ktype keyboard * add readme to m10a * add readme to mini1800 * add readme to parent directory
-rw-r--r--keyboards/k_type/readme.md13
-rw-r--r--keyboards/lfkeyboards/mini1800/readme.md12
-rw-r--r--keyboards/lfkeyboards/readme.md8
-rw-r--r--keyboards/m10a/readme.md13
4 files changed, 46 insertions, 0 deletions
diff --git a/keyboards/k_type/readme.md b/keyboards/k_type/readme.md
new file mode 100644
index 0000000000..ad4dd8ad84
--- /dev/null
+++ b/keyboards/k_type/readme.md
@@ -0,0 +1,13 @@
+# Input Club K-Type
+
+Firmware for custom keyboard PCB with TKL Key Layout
+
+Keyboard Maintainer: [Kaleb Elwert](https://github.com/belak)
+Hardware Supported: Input Club K-Type
+Hardware Availability: [Input Club](https://input.club/k-type/), [Massdrop](https://www.massdrop.com/buy/massdrop-x-input-club-k-type-mechanical-keyboard?utm_source=linkshare&referer=WJJG5M)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make k_type:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
diff --git a/keyboards/lfkeyboards/mini1800/readme.md b/keyboards/lfkeyboards/mini1800/readme.md
new file mode 100644
index 0000000000..96de85df1d
--- /dev/null
+++ b/keyboards/lfkeyboards/mini1800/readme.md
@@ -0,0 +1,12 @@
+Mini1800
+===
+
+Keyboard Maintainer: [LFKeyboards](https://github.com/lfkeyboards)
+Hardware Supported: Mini1800
+Hardware Availability: [LFKeyboards.com](https://www.lfkeyboards.com/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make lfkeyboards/mini1800:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
diff --git a/keyboards/lfkeyboards/readme.md b/keyboards/lfkeyboards/readme.md
new file mode 100644
index 0000000000..0fd05adefd
--- /dev/null
+++ b/keyboards/lfkeyboards/readme.md
@@ -0,0 +1,8 @@
+LFKeyboards
+===
+This is the parent directory for all LFKeyboard keyboards.
+
+Keyboard Maintainer: [LFKeyboards](https://github.com/lfkeyboards)
+Hardware Availability: [LFKeyboards.com](https://www.lfkeyboards.com/)
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
diff --git a/keyboards/m10a/readme.md b/keyboards/m10a/readme.md
new file mode 100644
index 0000000000..6e48b22857
--- /dev/null
+++ b/keyboards/m10a/readme.md
@@ -0,0 +1,13 @@
+# Rama Works X Machine Industries M10-A Macropad
+
+Firmware for custom macropad PCB
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: Rama Works M10-A
+Hardware Availability: [Rama Works](https://rama.works/m10-a)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make m10a:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.