qmk_firmware/keyboards/wren/readme.md

# Wren

![Wren PCB](https://raw.githubusercontent.com/walterhanley/wren-keyboard/main/images/wren-universal.png)
![Wren Layout](https://raw.githubusercontent.com/walterhanley/wren-keyboard/main/images/author-layout.png)

A split ergonomic "system keyboard" aimed at providing numpad and nav cluster functionality. For more information, please see the [project repo](https://github.com/walterhanley/wren-keyboard).

* Keyboard Maintainer: [Walter Hanley](https://github.com/walterhanley)
* Hardware Supported: Wren Universal PCB and Elite C (Pro Micro configurations likely supported but not tested)
* Hardware Availability: Source files available at [project repository](https://github.com/walterhanley/wren-keyboard)

Make example for this keyboard (after setting up your build environment):

    make wren:default

Flashing example for this keyboard:

    make wren:default:flash

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).

## Bootloader

Enter the bootloader in 2 ways:

* **Physical reset button**: Briefly press the button on the front of the PCB below the microcontroler
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
[Keyboard] Add Support for Wren Keyboard (#14570) * initial prime_o commit * Cleaned up comments, other things. * Updated keymap to use standard seven-underscore KC_TRNS notation * initial prime_o commit * Cleaned up comments, other things. * Updated keymap to use standard seven-underscore KC_TRNS notation * Initial Code for Wren Keyboard This is the initial hardware test commit for the wren. More detailed keymaps will be added soon. * Update layout and add author * Add PCB Image and Clarify Bootloader Instructions * Update config.h Updating config.h to remove mentions to LED backlighting (not supported on this PCB) * Update wren.h to match PR checklist * Roll back addition of code that should have been in wren.h * Update /default/keymap.c Make keyboard.c "pristine" to the best of my ability and add information about configuring a "non-standard" layout. * Update readme.md * Update keymap readmes to match PR checklist * Update readme.md * Final touches before PR * Un-delete non-wren files * Create rules.mk * Create config.h * Update keyboards/wren/keymaps/walterhanley/keymap.c * Update keyboards/wren/keymaps/walterhanley/keymap.c * Update keyboards/wren/wren.c As per feedback, move encoder definition to wren.c from keymap.c. * Update keyboards/wren/keymaps/walterhanley/keymap.c As per feedback, move encoder definition to wren.c from keymap.c * Update keyboards/wren/keymaps/default/keymap.c As per feedback, move encoder definition to wren.c from keymap.c * Create Keymap-Level config.h I've been dealing with some issues with this board over-drawing power on certain devices; this should fix that issue on my build without affecting other users. * Add bells and whistles to personal keymap This update adds bells and whistles to my personal keymap. I couldn't figure out how to modify rotary encoder functionality for just my personal layout with the definition in wren.c, so I moved it back into the individual keymaps. Please let me know if this is an issue and I can look into possible alternative implementations. * Update to match drashna's requested changes * Update keymap.c This update refines drashna's requested changes. * Update keymap.c Fix typo 2022-01-07 02:38:42 +01:00			`# Wren`

			`![Wren PCB](https://raw.githubusercontent.com/walterhanley/wren-keyboard/main/images/wren-universal.png)`
			`![Wren Layout](https://raw.githubusercontent.com/walterhanley/wren-keyboard/main/images/author-layout.png)`

			`A split ergonomic "system keyboard" aimed at providing numpad and nav cluster functionality. For more information, please see the [project repo](https://github.com/walterhanley/wren-keyboard).`

			`* Keyboard Maintainer: [Walter Hanley](https://github.com/walterhanley)`
			`* Hardware Supported: Wren Universal PCB and Elite C (Pro Micro configurations likely supported but not tested)`
			`* Hardware Availability: Source files available at [project repository](https://github.com/walterhanley/wren-keyboard)`

			`Make example for this keyboard (after setting up your build environment):`

			`make wren:default`

			`Flashing example for this keyboard:`

			`make wren:default:flash`

			`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).`

			`## Bootloader`

			`Enter the bootloader in 2 ways:`

			`* Physical reset button: Briefly press the button on the front of the PCB below the microcontroler`
RESET -> QK_BOOT keyboard readme (#18110) 2022-08-20 12:34:17 +02:00			* Keycode in layout: Press the key mapped to `QK_BOOT` if it is available