summaryrefslogtreecommitdiffstats
path: root/users/ninjonas/README.md
diff options
context:
space:
mode:
authorJonas Avellana <14019120+ninjonas@users.noreply.github.com>2019-09-25 22:28:06 -0600
committerDrashna Jaelre <drashna@live.com>2019-09-25 21:28:06 -0700
commitff854565ce012a325ad04b09a7bcb7c8bb9d43c5 (patch)
tree69d4970d4ea40d49483f232bf404d16f383957ba /users/ninjonas/README.md
parent2a948e77715f0bd11d4b80315cf84c68890014d4 (diff)
[Keymap] ninjonas keymap for crkbd & ninjonas userspace updates (#6797)
* [keymap(crkbd)] introducing crkbd keymap on ninjonas profile * [keymap(crkbd)] introducing crkbd keymap on ninjonas profile * [refactor(crkbd)] reducing file size by selecting RGB animations * [refactor(crkbd)] added shiftit key * [refactor(crkbd)] added shiftit key * [chore(crkbd)] adding SLEEP_LED_ENABLE on rules.mk * [refactor(crkbd)] added keylog & removed static rainbow RGB * [feat(crkbd)] introduced em-dash '—' keymap * [feat(crkbd)] added screenshot functionality * [refactor(lily58,pinky3)] moving media keys * [refactor(lily58)] Added emdash key * [chore] removing NUMBERS & FUNCTIONS layers as they're useless * [chore] removing NUMBERS & FUNCTIONS layers as they're useless * [chore(crkbd,lily48)] Updating README.md * [feat] added K_LAPP & K_RAPP to mimic command + tab * [feat] added K_LAPP & K_RAPP to mimic command + tab * [fix(#6797)] resolving changes requested by @drashna * [fix(#6797)] first cut on using QMK OLED Driver * [fix(#6797)] cleaning up rules.mk * [fix(#6797)] making scrolling logo work * [fix(#6797)] Using OLED Driver for Lily58 * [fix(#6797)] Moved OLED driver implementation to ninjonas userspace * [fix(#6797)] Bringing back crkbd & lily58 logos * [fix(#6797)] Turning off OLED based off @drashna's workaround in #5982 * [fix(#6797)] whoops! forgot to checkin crkbd/config.h * [fix(#6797)] fixing issue with OLED randomly turning on * [fix(#6797)] using default glcdfont.c for lily58 & crkbd * [fix(#6797)] Using LINK_TIME_OPTIMIZATION_ENABLE rather than EXTRAFLAGS as per code review * [fix(#6797)] updating M_MALL macro as per code review by @fauxpark
Diffstat (limited to 'users/ninjonas/README.md')
-rw-r--r--users/ninjonas/README.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/users/ninjonas/README.md b/users/ninjonas/README.md
index 82bd5f09a0..fb14bfe6c2 100644
--- a/users/ninjonas/README.md
+++ b/users/ninjonas/README.md
@@ -6,27 +6,35 @@ See: https://docs.qmk.fm/#/feature_userspace
- 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"
+ #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)
+
## Features
-### [Keys](ninjonas.h#L44)
+### [Keys](ninjonas.h#L40)
|Code | Description |
|---|---|
|K_LOCK | MacOS shortcut to execute lock command  + 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_RAPP | MacOS shortcut to switch apps to the right |
+|K_LAPP | MacOS shortcut to switch apps to the left |
-### [Layers](ninjonas.h#L48)
+### [Layers](ninjonas.h#L47)
|Code | Description |
|---|---|
|LT_LOW | Tap for ENTER, hold for RAISE |
-|LT_FUNC | Tap for ENTER, hold for FUNCTIONS |
|LT_RAI | Tap for SPACE, hold for LOWER |
-|LT_NUM | Tap for SPACE, hold for NUMBERS |
|LT_LOW + LT_RAI | Hold for ADJUST |
-|L_LOWER | Dedicated key to momentarily toggle to use LOWER layer |
+|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#L57)
+### [Layout Blocks](ninjonas.h#L53)
Predefined keyboard layout templates to speed up configuring split keyboards
|Code | Description |
@@ -69,7 +77,7 @@ There's times where you have macros you don't want to share like emails, passwor
```c
// secrets.c
-#include "ninjonas.h"
+#include "ninjonas.h"
bool process_record_secrets(uint16_t keycode, keyrecord_t *record) {
switch (keycode) {