diff options
Diffstat (limited to 'users/ninjonas/README.md')
| -rw-r--r-- | users/ninjonas/README.md | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/users/ninjonas/README.md b/users/ninjonas/README.md index fb14bfe6c..32ccdc699 100644 --- a/users/ninjonas/README.md +++ b/users/ninjonas/README.md | |||
| @@ -16,7 +16,7 @@ See: https://docs.qmk.fm/#/feature_userspace | |||
| 16 | - [Lily58](../../keyboards/lily58/keymaps/ninjonas) | 16 | - [Lily58](../../keyboards/lily58/keymaps/ninjonas) |
| 17 | 17 | ||
| 18 | ## Features | 18 | ## Features |
| 19 | ### [Keys](ninjonas.h#L40) | 19 | ### [Keys](ninjonas.h#L37) |
| 20 | |Code | Description | | 20 | |Code | Description | |
| 21 | |---|---| | 21 | |---|---| |
| 22 | |K_LOCK | MacOS shortcut to execute lock command + ctrl + Q | | 22 | |K_LOCK | MacOS shortcut to execute lock command + ctrl + Q | |
| @@ -25,7 +25,7 @@ See: https://docs.qmk.fm/#/feature_userspace | |||
| 25 | |K_RAPP | MacOS shortcut to switch apps to the right | | 25 | |K_RAPP | MacOS shortcut to switch apps to the right | |
| 26 | |K_LAPP | MacOS shortcut to switch apps to the left | | 26 | |K_LAPP | MacOS shortcut to switch apps to the left | |
| 27 | 27 | ||
| 28 | ### [Layers](ninjonas.h#L47) | 28 | ### [Layers](ninjonas.h#L44) |
| 29 | |Code | Description | | 29 | |Code | Description | |
| 30 | |---|---| | 30 | |---|---| |
| 31 | |LT_LOW | Tap for ENTER, hold for RAISE | | 31 | |LT_LOW | Tap for ENTER, hold for RAISE | |
| @@ -34,7 +34,7 @@ See: https://docs.qmk.fm/#/feature_userspace | |||
| 34 | |LM_LOW | Dedicated key to momentarily toggle to use LOWER layer | | 34 | |LM_LOW | Dedicated key to momentarily toggle to use LOWER layer | |
| 35 | |LM_RAI | Dedicated key to momentarily toggle to use RAISE layer | | 35 | |LM_RAI | Dedicated key to momentarily toggle to use RAISE layer | |
| 36 | 36 | ||
| 37 | ### [Layout Blocks](ninjonas.h#L53) | 37 | ### [Layout Blocks](ninjonas.h#L50) |
| 38 | Predefined keyboard layout templates to speed up configuring split keyboards | 38 | Predefined keyboard layout templates to speed up configuring split keyboards |
| 39 | 39 | ||
| 40 | |Code | Description | | 40 | |Code | Description | |
| @@ -59,6 +59,7 @@ Predefined keyboard layout templates to speed up configuring split keyboards | |||
| 59 | |M_VRSN | macro to send QMK version | | 59 | |M_VRSN | macro to send QMK version | |
| 60 | |M_SHFT | Sends + alt + shift to a keycode to activate [ShiftIt](https://github.com/fikovnik/ShiftIt) | | 60 | |M_SHFT | Sends + alt + shift to a keycode to activate [ShiftIt](https://github.com/fikovnik/ShiftIt) | |
| 61 | |M_CODE | Opens [Visual Studio Code](https://code.visualstudio.com/) on current directory | | 61 | |M_CODE | Opens [Visual Studio Code](https://code.visualstudio.com/) on current directory | |
| 62 | |M_XXX1 to M_XXX5 | Reserved for secret macros see [Secrets](#secrets) | | ||
| 62 | 63 | ||
| 63 | ### [Tap-Dance](tap_dances.h) | 64 | ### [Tap-Dance](tap_dances.h) |
| 64 | |Code | Description | | 65 | |Code | Description | |
| @@ -73,21 +74,29 @@ Predefined keyboard layout templates to speed up configuring split keyboards | |||
| 73 | |T_Q | Tap for Q, double tap for + Q | | 74 | |T_Q | Tap for Q, double tap for + Q | |
| 74 | 75 | ||
| 75 | ### Secrets | 76 | ### Secrets |
| 76 | There's times where you have macros you don't want to share like emails, passwords 😱, & and private strings. Based off [drashna's secret macros](https://github.com/qmk/qmk_firmware/blob/master/users/drashna/readme_secrets.md), it's now possible to do this. All you need to do is create a `secrets.c` file. Below is an example of how this is used. | 77 | There's times where you have macros you don't want to share like emails, an address you need but you always forget, passwords 😱, & and private strings. Based off [drashna's secret macros](https://github.com/qmk/qmk_firmware/blob/master/users/drashna/readme_secrets.md), it's now possible to do this. All you need to do is create a `secrets.c` file. Below is an example of how this is used. |
| 77 | 78 | ||
| 78 | ```c | 79 | ```c |
| 79 | // secrets.c | 80 | // secrets.c |
| 80 | #include "ninjonas.h" | 81 | #include "ninjonas.h" |
| 82 | |||
| 83 | static const char * const secret[] = { | ||
| 84 | "BLANK1", | ||
| 85 | "BLANK2", | ||
| 86 | "BLANK3", | ||
| 87 | "BLANK4", | ||
| 88 | "BLANK5" | ||
| 89 | }; | ||
| 81 | 90 | ||
| 82 | bool process_record_secrets(uint16_t keycode, keyrecord_t *record) { | 91 | bool process_record_secrets(uint16_t keycode, keyrecord_t *record) { |
| 83 | switch (keycode) { | 92 | switch (keycode) { |
| 84 | // Sends zoom URL | 93 | case M_XXX1...M_XXX5: |
| 85 | case M_ZOOM: | ||
| 86 | if (record->event.pressed) { | 94 | if (record->event.pressed) { |
| 87 | SEND_STRING("SECRET_STRING_HERE" SS_TAP(X_ENTER)); | 95 | send_string(secret[keycode - M_XXX1]); |
| 88 | } | 96 | } |
| 89 | break; | 97 | break; |
| 90 | } | 98 | } |
| 91 | return true; | 99 | return true; |
| 92 | } | 100 | } |
| 101 | |||
| 93 | ``` \ No newline at end of file | 102 | ``` \ No newline at end of file |
