summaryrefslogtreecommitdiff
path: root/keyboards/wren/keymaps/default/readme.md
diff options
context:
space:
mode:
authorWalter Hanley <walterphanley@gmail.com>2022-01-06 19:38:42 -0600
committerGitHub <noreply@github.com>2022-01-06 17:38:42 -0800
commitdb8cf0b872a1350f11d2de931f7b375feaec69c2 (patch)
tree0bb81fa745f3dcf0c310dd1308a3ded6e3aa45aa /keyboards/wren/keymaps/default/readme.md
parent845529782ef13a3d3f86443cf74082832eb71d9d (diff)
[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
Diffstat (limited to 'keyboards/wren/keymaps/default/readme.md')
-rw-r--r--keyboards/wren/keymaps/default/readme.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/keyboards/wren/keymaps/default/readme.md b/keyboards/wren/keymaps/default/readme.md
new file mode 100644
index 0000000000..7227050dd4
--- /dev/null
+++ b/keyboards/wren/keymaps/default/readme.md
@@ -0,0 +1,11 @@
+![Default Layout](https://github.com/walterhanley/wren-keyboard/blob/main/images/author-layout.png?raw=true)
+
+# Default Wren Layout
+
+This is the default Wren layout, which lacks any layers. It should be fairly
+straightforward, with the sole exception of the equals key in the place of the
+grave key and the grave key in the place of the delete key.
+
+This layout preserves the entire keyboard matrix, but only includes keycodes
+for a numpad/nav cluster configuration. Depending on your configuration, you
+may need to replace some of the existing KC_NO values with actual keycodes.