summaryrefslogtreecommitdiff
path: root/keyboards/knops/mini/readme.md
diff options
context:
space:
mode:
authorPawnerd <Pawnerd@users.noreply.github.com>2017-11-02 02:24:59 +0100
committerJack Humbert <jack.humb@gmail.com>2017-11-01 21:24:59 -0400
commit54a8abd785d46c879dfedb740df782b20521e086 (patch)
treeedb73841a403b54a5ad3ced823201d914dca3e0a /keyboards/knops/mini/readme.md
parentd6ad9787a07288235c9db4a51737f4f8a1a876e5 (diff)
downloadqmk_firmware-54a8abd785d46c879dfedb740df782b20521e086.tar.gz
qmk_firmware-54a8abd785d46c879dfedb740df782b20521e086.zip
Added support for Knops Mini (3x2 macropad) keyboard. (#1953)
* Added support for Knops Mini (3x2 macropad) keyboard. * Added better documentation, according to the QMK standards. * Fixed typo. * Changed names of files to comply with QMK standards. * Ignored makefile in keymap. * Removed makefiles and added my credentials in the copyrights.
Diffstat (limited to 'keyboards/knops/mini/readme.md')
-rw-r--r--keyboards/knops/mini/readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/keyboards/knops/mini/readme.md b/keyboards/knops/mini/readme.md
new file mode 100644
index 0000000000..86cff4a61f
--- /dev/null
+++ b/keyboards/knops/mini/readme.md
@@ -0,0 +1,21 @@
+# Knops Mini
+
+![Knops logo](http://knops.io/img/Knops_logo.jpg)
+
+![Knops mini keyboard](https://i.imgur.com/AMrXVi4.jpg)
+
+A fully customizable 3x2 macropad. An exploded view of the keyboard is [available here](https://i.imgur.com/H83l5H8.gif).
+
+*The best way to change settings on your keyboard*, is by using [our official configurator tool](http://knops.io/configurator.html).
+
+* Keyboard Maintainer: [Pawnerd](https://github.com/pawnerd)
+* Contact / Questions (by e-mail): kayle `at` knops `dot` io
+* Hardware Supported: Knops Mini
+ * rev1 (1.0) (Sold by CMStore EU/USA/CAD from 27th of august, 2017)
+* Hardware Availability: [knops.io](http://knops.io/knopsmini.html), [Direct EU](http://www.cmstore.eu/maker-made/knops-mini-macro-keyboard/), [Direct USA/CAN](http://www.cmstore-usa.com/knops-mini-macro-keyboard/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make knops/mini: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. \ No newline at end of file