aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/honeycomb/readme.md
diff options
context:
space:
mode:
authorGravatar Carlos <filoxo@users.noreply.github.com>2019-02-05 10:59:10 -0700
committerGravatar Drashna Jaelre <drashna@live.com>2019-02-05 09:59:10 -0800
commitd4e1e712f68567dfed6ff19cf762d01f6bb3d60c (patch)
treef3fdeb1c2702ba18aec11c67935a2dea24d5bc36 /keyboards/honeycomb/readme.md
parent612dc232d7e1e88dcd21be09eb32ef7099af854a (diff)
downloadqmk_firmware-d4e1e712f68567dfed6ff19cf762d01f6bb3d60c.tar.gz
dd Honeycomb macropad (#5000)
* Add Honeycome macropad * Replace pragma, update info * Update code based on review
Diffstat (limited to 'keyboards/honeycomb/readme.md')
-rwxr-xr-xkeyboards/honeycomb/readme.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/keyboards/honeycomb/readme.md b/keyboards/honeycomb/readme.md
new file mode 100755
index 000000000..955f0ac7a
--- /dev/null
+++ b/keyboards/honeycomb/readme.md
@@ -0,0 +1,20 @@
+Honeycomb Keyboard Firmware
+======================
+
+These configuration files use a completely different 'matrix scan' system than other keyboards, it relies on an external nRF51822 microcontroller maintaining a matrix of keystates received from the macropad - it also receives rotary encoder information from the macropad. The matrix.c file contains the code to poll the external microcontroller for the key matrix, and the keymap.c file contains example code for encoder use. As long as the relevant functions in these files are not changed, all other QMK features are supported.
+
+## Building
+
+Run the following command in your terminal:
+
+```
+make honeycomb:default
+# or use this to automatically flash the controller
+make honeycomb:default:avrdude
+```
+
+Follow the QMK guide for this or ask in Discord.
+
+### Other Keymaps
+
+Because this is a totally custom macropad, it is recommended that you copy the `default/` folder, rename it as desired, and modify the `keymap.c` to your liking. \ No newline at end of file