aboutsummaryrefslogtreecommitdiffstats
path: root/users/ninjonas/README.md
diff options
context:
space:
mode:
authorGravatar Jonas Avellana <14019120+ninjonas@users.noreply.github.com>2019-09-30 11:50:27 -0600
committerGravatar Drashna Jaelre <drashna@live.com>2019-09-30 10:50:27 -0700
commitcffe671a61e8187b39a508556c7a5b5f04835d24 (patch)
tree071199e57f8c1db1c18af28aa19dda78595a1c67 /users/ninjonas/README.md
parentf418efcaf5d681e87bd23b4d28621b87ff61fcb9 (diff)
downloadqmk_firmware-cffe671a61e8187b39a508556c7a5b5f04835d24.tar.gz
[Keymap] Updating crkbd RGB keymap implementation & ninjonas userspace updates (#6834)
* [keymap] Updating crkbd RGB implementation & ninjonas userspace updates * [chore] adding process_record_oled method to process_records.h
Diffstat (limited to 'users/ninjonas/README.md')
-rw-r--r--users/ninjonas/README.md25
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
- [Lily58](../../keyboards/lily58/keymaps/ninjonas)
## Features
-### [Keys](ninjonas.h#L40)
+### [Keys](ninjonas.h#L37)
|Code | Description |
|---|---|
|K_LOCK | MacOS shortcut to execute lock command  + ctrl + Q |
@@ -25,7 +25,7 @@ See: https://docs.qmk.fm/#/feature_userspace
|K_RAPP | MacOS shortcut to switch apps to the right |
|K_LAPP | MacOS shortcut to switch apps to the left |
-### [Layers](ninjonas.h#L47)
+### [Layers](ninjonas.h#L44)
|Code | Description |
|---|---|
|LT_LOW | Tap for ENTER, hold for RAISE |
@@ -34,7 +34,7 @@ See: https://docs.qmk.fm/#/feature_userspace
|LM_LOW | Dedicated key to momentarily toggle to use LOWER layer |
|LM_RAI | Dedicated key to momentarily toggle to use RAISE layer |
-### [Layout Blocks](ninjonas.h#L53)
+### [Layout Blocks](ninjonas.h#L50)
Predefined keyboard layout templates to speed up configuring split keyboards
|Code | Description |
@@ -59,6 +59,7 @@ Predefined keyboard layout templates to speed up configuring split keyboards
|M_VRSN | macro to send QMK version |
|M_SHFT | Sends  + alt + shift to a keycode to activate [ShiftIt](https://github.com/fikovnik/ShiftIt) |
|M_CODE | Opens [Visual Studio Code](https://code.visualstudio.com/) on current directory |
+|M_XXX1 to M_XXX5 | Reserved for secret macros see [Secrets](#secrets) |
### [Tap-Dance](tap_dances.h)
|Code | Description |
@@ -73,21 +74,29 @@ Predefined keyboard layout templates to speed up configuring split keyboards
|T_Q | Tap for Q, double tap for  + Q |
### Secrets
-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.
+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.
```c
// secrets.c
-#include "ninjonas.h"
+#include "ninjonas.h"
+
+static const char * const secret[] = {
+ "BLANK1",
+ "BLANK2",
+ "BLANK3",
+ "BLANK4",
+ "BLANK5"
+};
bool process_record_secrets(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {
- // Sends zoom URL
- case M_ZOOM:
+ case M_XXX1...M_XXX5:
if (record->event.pressed) {
- SEND_STRING("SECRET_STRING_HERE" SS_TAP(X_ENTER));
+ send_string(secret[keycode - M_XXX1]);
}
break;
}
return true;
}
+
``` \ No newline at end of file