Add readme files to my keymaps and userspace

qmk · jackhumbert · Dec 14, 2017 · Dec 8, 2017 · Dec 12, 2017 · Dec 12, 2017
commit d9d35c337471c1246231b1a98348e3766381bde0
diff --git a/keyboards/ergodox_ez/keymaps/drashna/README.md b/keyboards/ergodox_ez/keymaps/drashna/README.md
@@ -0,0 +1,25 @@
+Overview
+========
+
+This is my personal Ergodox EZ configuration, and my daily driver.
+
+Most of the code resides in my userspace, rather than here, as I have multiple keyboards.
+
+How to build 
+------------
+make ergodox_ez:drashna:teensy
+
+Layers
+------
+* QWERTY/DVORAK/COLEMAK/WORKMAN: basic layout, default set like the OLKB boards. Default is set and persists on power cycle.
+* SYMB: F keys across the top, symbols on the left and numpad on the right.
+* GAMEPAD: This is the QWERTY layout shifted to the right for FPS type games. Destiny and Overwatch are the primary games for this.
+* DIABLO: This contains a Diablo 3 layout, that requires much less reaching or shifting. If Tap Dance is enabled, then it has a "spam" feature. See Userspace for details.
+* MOUSE: mouse navigation
+
+All layers have RGB specific indicators, so you can see what layer you're on by the underglow.
+
+Ergodox Specific Code
+---------------------
+
+Aside from my userspace code, this includes LED indications for Shift (Green LED), Ctrl (Red LED), and Alt (Blue LED).
diff --git a/keyboards/handwired/woodpad/keymaps/drashna/README.md b/keyboards/handwired/woodpad/keymaps/drashna/README.md
@@ -0,0 +1,25 @@
+Overview
+========
+
+This is my personal Numpad (Woodpad) configuration, and my daily driver.
+
+Most of the code resides in my userspace, rather than here, as I have multiple keyboards.
+
+How to build 
+------------
+make handwired/woodpad:drashna:avrdude
+
+Layers
+------
+* NUMLOCK: Num pad, locked to NUM LOCK enabled. 
+* NAV: Navigation codes without needing to enable numlock. 
+* DIABLO: This contains a Diablo 3 layout, that requires much less reaching or shifting. If Tap Dance is enabled, then it has a "spam" feature. See Userspace for details.
+* MACROS: This layer contains a bunch of macros for spamming chat, with a toggle on what key to open up chat with. 
+* MEDIA: Media and RGB commands
+
+All layers have RGB specific indicators, so you can see what layer you're on by the underglow.
+
+Woodpad Specific Code
+---------------------
+
+Aside from my userspace code, this includes LED indications for numlock and macro mode.  It also forces NUMLOCK to be enabled.
diff --git a/keyboards/orthodox/keymaps/drashna/README.md b/keyboards/orthodox/keymaps/drashna/README.md
@@ -0,0 +1,26 @@
+Overview
+========
+
+This is my personal Orthodox configuration, and my daily driver.
+
+Most of the code resides in my userspace, rather than here, as I have multiple keyboards.
+
+How to build 
+------------
+make orthodox/rev1:drashna:teensy
+
+Layers
+------
+* QWERTY/DVORAK/COLEMAK/WORKMAN: basic layout, default set like the OLKB boards. Default is set and persists on power cycle.
+* RAISE: Contains function keys and unshifted symbols
+* LOWER: Contains function keys and shifted symbols
+* ADJUST: contains special codes (layout defaults, RGB codes, Audio codes, and volume control)
+
+All layers have RGB specific indicators, so you can see what layer you're on by the underglow.
+
+Orthodox Specific Code
+----------------------
+
+Left side is designed to have RGB underglow and Faux Clicking enabled, while the right has Audio enabled.  
+
+The make commend ensures that the correct settings are retained. 
diff --git a/users/drashna/readme.md b/users/drashna/readme.md
@@ -1,14 +1,98 @@
-Copyright 2017 Christopher Courtney <drashna@live.com> @drashna
+Overview
+========
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 2 of the License, or
-(at your option) any later version.
+This is my personal userspace file.  Most of my code exists here, as it's heavily shared. 
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+Custom handlers
+---------------
+
+All (most) `_user` functions are handled here instead.  To allow keyboard specific configuration, I've created `_keymap` functions that can be called by the keymap.c files instead.
+
+This allows for keyboard specific configuration while maintaining the ability to customize the board. 
+
+My Ergodox EZ Keymap is a good example of this, as it uses the LEDs as modifier indicators.
+
+Custom Keycodes
+---------------
+
+Keycods are defined in the drashna.h file and need to be included in the keymap.c files, so that they can be used there. 
+
+A bunch of macros are present and are only included on boards that are not the Ergodox EZ or Orthodox, as they are not needed for those boards. 
+
+Included is a custom macro for compiling my keyboards.  This includes the bootloader target (`:teensy`, `:avrdude`, or `:dfu`), and keeps RGBLIGHT, AUDIO and/or FAUXCLICKY enabled, if it previously was (regardless of the rules file).
+
+This also includes a modified RESET keycode as well, that sets the underglow to red. 
+
+Layer Indication
+----------------
+
+This uses the `layer_state_set_*` command to change the layer color, to indicate which layer it is on.  This includes the default keymap, as well.
+
+Since this is done via userspace, it is the same between all systems. 
+
+Additionally, there is a custom keycode to toggle layer indication. And all RGB keycodes disable layer indication by default, as well.  This way, I can leave special effects doing when I want.
+
+Also. I use `rgblight_sethsv` since it works with animation modes (that support it).
+
+
+Diablo Layer
+------------
+
+This layer has some special handling.
+
+When Tap Dances are enabled, this layer has the ability to "spam" keypresses.  
+
+For instance, tapping the TD "1" twice causes the layer to hit "1" ever 1 second (appoximately).  This is useful for auto-hotkeying skills (such as bone armor or devour).
+
+Tappind once disables this, and switching layers temporarily disables this, until you switch back to the layer. 
+
+For critics that think this is cheating, search "diablo 3 num lock auto cast".  This is just a simpler method, since I no longer own a normal (non QMK) numpad. 
+
+Secret Macros
+-------------
+
+With help from gitter and Colinta, this adds the ability to add hidden strings to be used for macros.
+
+I have a number of long strings that I need to use that are semi-private.  This uses the `__has_include` function to check for the file. If it exists, then it includes the custom text. Otherwise, it uses some default values. 
+
+If you would *also* like to take advantage of this feature, you'll first want to make sure your "secrets" file isn't included in the repo.  Open `.git/info/exclude` and add `secrets.h` to that file, below the comments.
+
+###### .git/info/exclude
+```
+# git ls-files --others --exclude-from=.git/info/exclude
+# Lines that start with '#' are comments.
+# For a project mostly in C, the following would be a good set of
+# exclude patterns (uncomment them if you want to use them):
+# *.[oa]
+# *~
+/users/drashna/secrets.h
+```
+
+Then you can create this file and add your macro strings to it:
+
+###### secrets.h
+```
+PROGMEM const char secret[][64] = {
+  "secret1",
+  "secret2",
+  "secret3",
+  "secret4",
+  "secret5"
+};
+```
+
+Replacing the strings with the codes that you need. 
+
+
+These are called in the `process_record_user` function, using this block:
+```
+  case KC_SECRET_1 ... KC_SECRET_5:
+    if (!record->event.pressed) {
+      send_string_P(secret[keycode - KC_SECRET_1]);
+    }
+    return false;
+    break;
+```
+
+And this requires `KC_SECRET_1` through `KC_SECRET_5` to be defined, as well.