diff options
Diffstat (limited to 'users/ninjonas/README.md')
-rw-r--r-- | users/ninjonas/README.md | 117 |
1 files changed, 0 insertions, 117 deletions
diff --git a/users/ninjonas/README.md b/users/ninjonas/README.md deleted file mode 100644 index f6c2f32352..0000000000 --- a/users/ninjonas/README.md +++ /dev/null @@ -1,117 +0,0 @@ -# QMK User Configuration for [ninjonas](https://github.com/ninjonas/qmk-yonas) -Tired of copying and pasting the same macros and tap dances for all my keymaps. Utilizing user keymaps functionality. -See: https://docs.qmk.fm/#/feature_userspace - -## [ninjonas.c](ninjonas.c) -- ninjonas [QMK user configuration](https://github.com/qmk/qmk_firmware/blob/master/docs/feature_userspace.md) -- On `keymap.c` include `ninjonas.h` - ```c - #include "ninjonas.h" - ``` - -## Supported Keyboards -- [Crkbd ](../../keyboards/crkbd/keymaps/ninjonas) -- [Hotdox](../../keyboards/hotdox/keymaps/ninjonas) -- [Pinky3](../../keyboards/pinky/3/keymaps/ninjonas) -- [Lily58](../../keyboards/lily58/keymaps/ninjonas) -- [Kyria](../../keyboards/kyria/keymaps/ninjonas) - -## Features -### [Keys](ninjonas.h) -|Code | Description | -|---|---| -|K_LOCK | MacOS shortcut to execute lock command Cmd + CTRL + Q | -|K_CSCN | MacOS shortcut to copy a portion of the screen to the clipboard | -|K_MDSH | MacOS shortcut to get em-dash `–` | -|K_CPRF | Cmd + Shift + M. Used for switching Google Chrome profiles | - -### [Layers](ninjonas.h) -|Code | Description | -|---|---| -|LT_LOW | Tap for ENTER, hold for RAISE | -|LT_RAI | Tap for SPACE, hold for LOWER | - -### [Mod-Taps](ninjonas.h) -|Code | Description | -|---|---| -|MT_DEL | Tap for Delete, hold for ALT + SHIFT | -|MT_EQL | Tap for =, SHIFT | - -### [Layout Blocks](ninjonas.h) -Predefined keyboard layout templates to speed up configuring split keyboards - -|Code | Description | -|---|---| -|QWERTY | Qwerty Layout | -|DVORAK | Dvorak Layout | -|COLEMAK | Colemak Layout | -|NUM | Number Rows | -|FUNC | Function Rows | -|SYM | Symbol Rows \(When holding shift on numbers\) | -|NAV | Navigation Cluster | -|MOUSE | Mouse Cluster | -|MEDIA | Media Cluster | -|MOD | Modifier Cluster | -|NUMPAD | Numpad Cluster | - -### [Macros](process_records.c) -|Code | Description | -|---|---| -|M_PYNV | Macro to activate pyenv with the name `jira` | -|M_MAKE | Macro to send QMK make command to compile keyboard | -|M_MALL | Macro to send QMK make command to all [ninjonas](#Supported%20Keyboards) keyboards | -|M_FLSH | Macro to send QMK make command to compile keyboard with the correct bootloader | -|M_VRSN | Macro to send QMK version | -|M_SHFT | Sends Cmd + 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_TERM | Launches Spotlight and calls Terminal | -|M_XXX1 to M_XXX5 | Reserved for secret macros see [Secrets](#secrets) | - -### [Tap-Dance](tap_dances.h) -|Code | Description | -|---|---| -|T_ESC | Tap once for ESC, double tap for CAPS_LOCK | -|T_LBRC | Tap once for [, double for back browser | -|T_RBRC | Tap once for ], double for forward browser | -|T_TAB | Tap once for TAB, double for CTRL + TAB | -|T_GRV | Tap once for GRV, double for Cmd + GRV | -|T_GUI | Tap once for Cmd, double to open spotlight | -|T_CPAP | Tap for Cmd + V, hold for Cmd + C, double tap to open [Line](https://line.me/en/) app, triple tap for itunes. | -|T_Y | Tap for Y, double tap for NUMPAD layer | - -### [Combos](combos.h) -|Code | Description | -|---|---| -|EQ_QUIT | Press E + Q will trigger Cmd + Q | -|RW_CLOSE | Press R + W will trigger Cmd + W| -|ET_TAB | Press E + T will trigger Cmd + T| -|ZC_COPY | Press Z + C will trigger Cmd + C| -|XV_PASTE | Press X + V will trigger Cmd + V| - -### Secrets -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" - -static const char * const secret[] = { - "BLANK1", - "BLANK2", - "BLANK3", - "BLANK4", - "BLANK5" -}; - -bool process_record_secrets(uint16_t keycode, keyrecord_t *record) { - switch (keycode) { - case M_XXX1...M_XXX5: - if (record->event.pressed) { - send_string(secret[keycode - M_XXX1]); - } - break; - } - return true; -} - -```
\ No newline at end of file |