summaryrefslogtreecommitdiffstats
path: root/keyboards/nullbitsco/nibble/README.md
diff options
context:
space:
mode:
authorJay Greco <jayv.greco@gmail.com>2020-10-22 23:47:14 -0700
committerGitHub <noreply@github.com>2020-10-23 17:47:14 +1100
commit999326acc81687794e25ad7731f37da59881e0ca (patch)
treeceb786ae2dac25486a57c5ed004e921677c922b1 /keyboards/nullbitsco/nibble/README.md
parent8cbaea9e8d00b959ccb1b474fa8a81417b651de2 (diff)
Add nullbits nibble (#9250)
* Add NIBBLE keyboard * Update VID for VIA compatibility * Add QMK PR feedback * Update matrix_init_remote_kb() * Update with requested changes Clean up config, makefile rules, and keymap files * Update with changes for unified ANSI/ISO layout * Add NO_USB_STARTUP_CHECK note in readme * Add license info, update with PR changes -Refactor encoder, via_extras code -Refactor VIA specific code to live in keymap folder -Remove non-inclusive naming in remote keyboard.c/h -Add documentation to remote_keyboard.c -Add compiler check for vusb_detect for non-avr micros * Fix print formatter in encoder handler Co-authored-by: Nick Brassel <nick@tzarc.org> * Small PR updates -Remove unneded matrix code from nibble.c -Clean up include code in nibble_encoder.h * Update Big LED headerfile -Declare Big LED functions in header file (derp) * Update keyboards/nullbitsco/nibble/nibble.c -Update with drashna's suggested CAPS LED code change Co-authored-by: Drashna Jaelre <drashna@live.com> * Update keyboards/nullbitsco/nibble/rules.mk -Update with drasha's suggested makefile formatting changes Co-authored-by: Drashna Jaelre <drashna@live.com> * Fix caps_lock typo Co-authored-by: Nick Brassel <nick@tzarc.org> Co-authored-by: Drashna Jaelre <drashna@live.com>
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).