summaryrefslogtreecommitdiff
path: root/keyboards/knobgoblin/readme.md
diff options
context:
space:
mode:
authormrT1ddl3s <60518619+mrT1ddl3s@users.noreply.github.com>2021-01-24 23:25:50 -0700
committerGitHub <noreply@github.com>2021-01-24 22:25:50 -0800
commitbd5d3c879ef1bc019776d6736be76f98c12dd0fd (patch)
tree042e378209a22c37a9c591743ca0ee7fcfbf3269 /keyboards/knobgoblin/readme.md
parentc1e1166991579066672c73a42ce21f8d23d96f4c (diff)
[Keyboard] Knobgoblin keyboard initial commit (#11664)
* Knobgoblin keyboard initial commit New macropad initial commit. Keyboard and keymap * corrected bracket and layout name * attempting info file fix again * info file line 33 hanging comma fix * Update keyboards/knobgoblin/config.h per fauxpark review Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/knobgoblin/readme.md per fauxpark review Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/knobgoblin/readme.md per fauxpark review Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/knobgoblin/readme.md')
-rw-r--r--keyboards/knobgoblin/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/knobgoblin/readme.md b/keyboards/knobgoblin/readme.md
new file mode 100644
index 0000000000..20ebc92e94
--- /dev/null
+++ b/keyboards/knobgoblin/readme.md
@@ -0,0 +1,15 @@
+# KNOBGOBLIN
+
+![Knob Goblin](https://i.imgur.com/oYnzqqNl.jpg)
+
+A 5x4 numpad with 2x rotary encoder and OLED support.
+
+* Keyboard Maintainer: [MrT1ddl3s](https://github.com/mrT1ddl3s)
+* Hardware Supported: knobgoblin PCB
+* Hardware Availability: Occasional group buy.[knobgoblin.xyz](https://knobgoblin.xyz)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make knobgoblin: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).