summaryrefslogtreecommitdiffstats
path: root/keyboards/nullbitsco/nibble/readme.md
diff options
context:
space:
mode:
authorErovia <Erovia@users.noreply.github.com>2020-10-25 15:23:42 +0000
committerGitHub <noreply@github.com>2020-10-25 15:23:42 +0000
commitad86894ae7d5fbb7aed697d9f576cd186bfd1c9c (patch)
treec5ffe570301b95699d93566d5b9453bda203a7ae /keyboards/nullbitsco/nibble/readme.md
parentaf455a8368dc564df51f9657b04932956ccf580b (diff)
Rename keyboard-level readmes to lower-case (#10759)
This is the recommendation in the [PR Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it will make working with them easier in the CLI/API/etc.
Diffstat (limited to 'keyboards/nullbitsco/nibble/readme.md')
-rw-r--r--keyboards/nullbitsco/nibble/readme.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/keyboards/nullbitsco/nibble/readme.md b/keyboards/nullbitsco/nibble/readme.md
new file mode 100644
index 0000000000..92825847d6
--- /dev/null
+++ b/keyboards/nullbitsco/nibble/readme.md
@@ -0,0 +1,19 @@
+# NIBBLE
+
+![NIBBLE](https://nullbits.co/static/img/nibble1.jpg)
+
+A unique, tweakable 65% keyboard kit built by nullbits. [More info at nullbits.co](https://nullbits.co/nibble/)
+
+* Keyboard Maintainer: [Jay Greco](https://github.com/jaygreco)
+* Hardware Supported: NIBBLE Rev1, Pro Micro comaptible MCUs.
+* Hardware Availability: [nullbits.co](https://nullbits.co/)
+
+Note: If you are seeing issues with MacOS and keyboard hangs after sleep, make sure `NO_USB_STARTUP_CHECK = yes` is set in your rules.mk.
+
+Adds experimental "Remote Keyboard" functionality, which forwards keystrokes from an external macropad, keyboard, or numpad over UART/TRRS, removing the need for an additional USB connection.
+
+Make example for this keyboard (after setting up your build environment):
+
+ make nullbitsco/nibble: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).