summaryrefslogtreecommitdiff
path: root/layouts/community/ergodox/bocaj/readme.md
diff options
context:
space:
mode:
authorJacob Jerrell <jacob.jerrell@gmail.com>2020-12-06 00:30:27 -0600
committerGitHub <noreply@github.com>2020-12-06 17:30:27 +1100
commit3076f86dc11d346d07c63e5fb11702817d7034e7 (patch)
treeebf9b4f3dd89366069f2123a0c984692c3d98e52 /layouts/community/ergodox/bocaj/readme.md
parent6b1f96dca8b1218c0e3de6ef23dbde107f8c4588 (diff)
downloadqmk_firmware-3076f86dc11d346d07c63e5fb11702817d7034e7.tar.gz
qmk_firmware-3076f86dc11d346d07c63e5fb11702817d7034e7.zip
Bocaj - Third Annual Refactor (Redux) (#10295)
* Reset everything to upstream, reapply Bocaj changes * Bocaj - address PR comments * Just in time changes * Bocaj - Several adjustments after using the layout for a while
Diffstat (limited to 'layouts/community/ergodox/bocaj/readme.md')
-rw-r--r--layouts/community/ergodox/bocaj/readme.md47
1 files changed, 19 insertions, 28 deletions
diff --git a/layouts/community/ergodox/bocaj/readme.md b/layouts/community/ergodox/bocaj/readme.md
index 901822722e..f8bce4e577 100644
--- a/layouts/community/ergodox/bocaj/readme.md
+++ b/layouts/community/ergodox/bocaj/readme.md
@@ -1,37 +1,28 @@
-# Bocaj Layout
+# Overview
-While I've put my own spin on most things, much of the credit for these ideas belongs to Drashna and/or the people he derived things from. Please see his [layout](../drashna/) and [userspace](../../../../users/drashna/) for lots of ideas and inspiration.
+This is my personal Ergodox EZ configuration, and my daily driver.
-## Layers Overview
+Most of the code resides in my userspace and is heavily based upon [Drashna's work](https://github.com/qmk/qmk_firmware/tree/master/users/drashna)... although considerably slimmed down.
-* Default
- * Workman
- * Qwerty
- * Windows Workman (swaps GUI and CTRL buttons)
-* Lower
- * F1-12 Top Row
- * Grave / Layer Switch macro at Caps Lock position
- * Navigation at QWERTY 'ESDF' position
- * Numpad under right hand
-* Adjust
- * Volume Control
- * Mac Lock Macro
- * Make / Reset/ EEPROM keys
- * Default Layer changing keys
- * Diablo Layer
- * Moved shortcuts within left hands reach
- * Macros to spam 1-4 every ~1 second
- * Shift in thumb cluster to prevent pinky fatique
+## How to build
-## LEDs Overview
+Put simply:
+`make ergodox_ez:bocaj`
-* Used for _LOWER, _ADJUST, and _DIABLO layer indication
-* Used for Ctrl/GUI, Shift, and Alt indication when on a default layer
+On that note, I use a separate workspace when making changes to my layouts or userspace. In that repo, there is a tool that does this for me. See [JacobJerrell/qmk_layouts/tools/](https://github.com/JacobJerrell/qmk_layouts/tree/master/tools)
-## Wrappers Overview
+## Layers
-While it isn't a novel idea, I feel the need to mention it because it really appeals to me as a person that doesn't like repetitive code.
+* WORKMAN: No one uses this board but me and I've never had a reason to switch to QWERTY
+* LOWER:
+ * Left: Grave and navigation arrows
+ * Right: Numpad
+* RAISE:
+ * Symbols across the top, F-Keys on the second row
+* ADJUST
+ * Audio control, make/reset/version macros
+* MOD: mouse navigation
-We've all come to know and love the pretty wrapper for Ergodox because it makes for such a beautiful, self-documenting keymap. In this keymap, we are building ontop of the pretty wrapper to wrap our default layers with our keys that aren't unique to the layer.
+## Ergodox Specifics
-Now you can wrap your keymap with `LAYOUT_ergodox_pretty_base_wrapper()` and only feed it the alpha keys, having the top, side, bottom, and thumb clusters automatically filled in. If you make a key to any of the top, side, bottom, or thumb cluster keys, it will propegate to all layers that have this wrapper, or have KC_TRNS keycodes in the same location
+I don't have the underglow or backlit versions so the 3 LEDs on the right board are used for layer indication if not on the base layer. If you're on the base layer, they're used for mod-key indicators.