summaryrefslogtreecommitdiff
path: root/keyboards/leafcutterlabs/bigknob/readme.md
diff options
context:
space:
mode:
authorCraig Gardner <40006110+LeafCutterLabs@users.noreply.github.com>2021-01-06 10:00:05 -0800
committerGitHub <noreply@github.com>2021-01-06 10:00:05 -0800
commitb7b82d509bfccd69c6507761f03910f34b4366cb (patch)
tree30e361fe37d5382cd62cad5c4dafcd508f77bfba /keyboards/leafcutterlabs/bigknob/readme.md
parentbf959d79dc7a37e94fc368bb8d3a4ca52421faad (diff)
downloadqmk_firmware-b7b82d509bfccd69c6507761f03910f34b4366cb.tar.gz
qmk_firmware-b7b82d509bfccd69c6507761f03910f34b4366cb.zip
[Keyboard] add support for bigknob (#11291)
* add support for bigknob Add support for bigknob macropad * corrected files * Apply suggestions from code review Co-authored-by: Joel Challis <git@zvecr.com> * corrected tap dance * Update config.h * correct image link * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * added GPL headers * Update readme.md Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/leafcutterlabs/bigknob/readme.md')
-rw-r--r--keyboards/leafcutterlabs/bigknob/readme.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/keyboards/leafcutterlabs/bigknob/readme.md b/keyboards/leafcutterlabs/bigknob/readme.md
new file mode 100644
index 0000000000..d67a1858b5
--- /dev/null
+++ b/keyboards/leafcutterlabs/bigknob/readme.md
@@ -0,0 +1,15 @@
+# bigknob
+
+A 4 key Macropad with Rotary Encoder based on Atmega32u4.
+
+![](https://i.imgur.com/Px3EpOUl.jpg)
+
+* Keyboard Maintainer: [LeafCutterLabs](https://github.com/LeafCutterLabs)
+* Hardware Supported: Atmega32u4
+* Hardware availability: Case files are available [here](https://github.com/LeafCutterLabs/bigKNOB)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make leafcutterlabs/bigknob: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).