From 9f63bce70bd8e065e54de17c48994c3c008d2e0a Mon Sep 17 00:00:00 2001 From: peepeetee <43021794+peepeetee@users.noreply.github.com> Date: Tue, 19 Apr 2022 18:17:21 +0800 Subject: move keyhive exclusive boards into /keyhive (#16084) Co-authored-by: Nick Brassel --- keyboards/keyhive/honeycomb/readme.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100755 keyboards/keyhive/honeycomb/readme.md (limited to 'keyboards/keyhive/honeycomb/readme.md') diff --git a/keyboards/keyhive/honeycomb/readme.md b/keyboards/keyhive/honeycomb/readme.md new file mode 100755 index 0000000000..611aa63880 --- /dev/null +++ b/keyboards/keyhive/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 keyhive/honeycomb:default +# or use this to automatically flash the controller +make keyhive/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. -- cgit v1.2.3