summaryrefslogtreecommitdiff
path: root/keyboards/crkbd/keymaps/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 /keyboards/crkbd/keymaps/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 'keyboards/crkbd/keymaps/ninjonas/README.md')
-rw-r--r--keyboards/crkbd/keymaps/ninjonas/README.md99
1 files changed, 99 insertions, 0 deletions
diff --git a/keyboards/crkbd/keymaps/ninjonas/README.md b/keyboards/crkbd/keymaps/ninjonas/README.md
new file mode 100644
index 0000000000..24889a221d
--- /dev/null
+++ b/keyboards/crkbd/keymaps/ninjonas/README.md
@@ -0,0 +1,99 @@
+# ninjonas Keymap for [Corne Keyboard (crkbd)](https://github.com/foostan/crkbd)
+
+## Keymap
+This keymap is designed based off my typing habits and is subject to change. Information about custom user macros and tap dances can be found [here](../../../../users/ninjonas).
+
+More information about the crkbd keyboard can be found [here](https://thomasbaart.nl/2018/11/26/corne-keyboard-helidox-build-log/)
+
+### QWERTY
+```c
+ //,----------------------------------------------------. ,----------------------------------------------------.
+ // Tab, Q, W, E, R, T, Y, U, I, O, P, \
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // ESC, A, S, D, F, G, H, J, K, L, ;, '
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // LShift, Z, X, C, V, B, N, M, ,, ., /, =
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , Ctrl, Space, Enter, BackSP, Del
+ //`---------------------' `---------------------'
+```
+
+### DVORAK
+```c
+ //,----------------------------------------------------. ,----------------------------------------------------.
+ // Tab, ', ,, ., P, Y, F, G, C, R, L, \
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // ESC, A, O, E, U, I, D, H, T, N, S, /
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // LShift, ;, Q, J, K, X, B, M, W, V, Z, =
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , Ctrl, Space, Enter, BackSP, Del
+ //`---------------------' `---------------------'
+```
+
+### COLEMAK
+```c
+ //,----------------------------------------------------. ,----------------------------------------------------.
+ // Tab, Q, W, F, P, G, J, L, U, Y, ;, \
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // ESC, A, R, S, T, D, H, N, E, I, O, '
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // LShift, Z, X, C, V, B, K, M, ,, ., /, =
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , Ctrl, Space, Enter, BackSP, Del
+ //`---------------------' `---------------------'
+```
+
+### LOWER
+```c
+ //,----------------------------------------------------. ,----------------------------------------------------.
+ // , , KC_BRIU, Play, Mute, K_CSCN, PgUp, Home, Up, End, , K_MDSH
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , , KC_BRID, Next, VolUp, , PgDn, Left, Down, Right, K_LOCK,
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , , , Prev, VolDn, [, ], , , M_CODE, M_ZOOM, M_PYNV,
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , , , , ,
+ //`---------------------' `---------------------'
+```
+
+### RAISE
+```c
+ //,----------------------------------------------------. ,----------------------------------------------------.
+ // `, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, -
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // ~, !, @, #, $, %, ^, &, *, (, ), _
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // F11, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F12
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , , , , ,
+ //`---------------------' `---------------------'
+```
+
+### ADJUST
+```c
+ //,----------------------------------------------------. ,----------------------------------------------------.
+ // M_MAKE, EEP_RST, , , , , RGB_TOG, , , COLEMAK, DVORAK, QWERTY,
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // M_VRSN, M_MALL, , RGB_SAI, RGB_HUI, RGB_VAI, , , , , , ,
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // M_FLSH, , , RGB_SAD, RGB_HUD, RGB_VAD, RGB_M_P, RGB_M_B,RGB_M_SW, , , ,
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , , , , ,
+ //`---------------------' `---------------------'
+```
+
+<!--
+### TEMPLATE
+```c
+ //,----------------------------------------------------. ,----------------------------------------------------.
+ // , , , , , , , , , , ,
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , , , , , , , , , , ,
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , , , , , , , , , , ,
+ //|--------+--------+--------+--------+--------+-------| |--------+--------+--------+--------+--------+-------|
+ // , , , , ,
+ //`---------------------' `---------------------'
+```
+--> \ No newline at end of file