diff options
Diffstat (limited to 'keyboards/kc60')
| -rw-r--r-- | keyboards/kc60/keymaps/noroadsleft/keymap.c | 62 | ||||
| -rw-r--r-- | keyboards/kc60/keymaps/noroadsleft/readme.md | 132 | ||||
| -rw-r--r-- | keyboards/kc60/keymaps/noroadsleft/readme_ch1.md | 48 | ||||
| -rw-r--r-- | keyboards/kc60/keymaps/noroadsleft/readme_ch2.md | 36 | ||||
| -rw-r--r-- | keyboards/kc60/keymaps/noroadsleft/readme_ch3.md | 40 | ||||
| -rw-r--r-- | keyboards/kc60/keymaps/noroadsleft/readme_ch4.md | 110 | ||||
| -rw-r--r-- | keyboards/kc60/keymaps/noroadsleft/readme_git.md | 79 |
7 files changed, 124 insertions, 383 deletions
diff --git a/keyboards/kc60/keymaps/noroadsleft/keymap.c b/keyboards/kc60/keymaps/noroadsleft/keymap.c index 5ad100e0e7..f69371061e 100644 --- a/keyboards/kc60/keymaps/noroadsleft/keymap.c +++ b/keyboards/kc60/keymaps/noroadsleft/keymap.c @@ -1,4 +1,4 @@ -/* Copyright 2018-2020 James Young (@noroadsleft) +/* Copyright 2018-2021 James Young (@noroadsleft) * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -40,11 +40,7 @@ enum layer_names { // KEYCODE DEFINITIONS -#define NO_CHNG KC_TRNS // Note for me for keys I need to leave as Pass-through - #define FN_CAPS LT(_FN, KC_CAPS) // Function Layer when held, Caps Lock when tapped -#define Q2_CAPS LT(_FQ, KC_CAPS) // Quake 2 Function Layer when held, Caps Lock when tapped - #define CTL_GRV MT(MOD_LCTL, KC_GRV) // Left Control when held, Grave accent when tapped @@ -58,7 +54,6 @@ enum custom_keycodes { /******************* ** MODIFIER MASKS ** *******************/ -#define MOD_MASK_RALT (MOD_BIT(KC_RALT)) unsigned char q2InputMode = 0; @@ -118,51 +113,6 @@ bool process_record_keymap(uint16_t keycode, keyrecord_t *record) { } }; return false; - case KC_Z: - if (record->event.pressed) { - if ( get_mods() & MOD_MASK_RALT ) { - register_code(KC_NUBS); - } else { - register_code(KC_Z); - } - } else { - if ( get_mods() & MOD_MASK_RALT ) { - unregister_code(KC_NUBS); - } else { - unregister_code(KC_Z); - } - }; - return false; - case KC_1 ... KC_0: - if (record->event.pressed) { - if ( get_mods() & MOD_MASK_RALT ) { - register_code( keycode + 0x3B ); - } else { - register_code( keycode ); - } - } else { - if ( get_mods() & MOD_MASK_RALT ) { - unregister_code( keycode + 0x3B ); - } else { - unregister_code( keycode ); - } - } - return false; - case KC_F1 ... KC_F12: - if (record->event.pressed) { - if ( get_mods() & MOD_MASK_RALT ) { - register_code( keycode + 0x2E ); - } else { - register_code( keycode ); - } - } else { - if ( get_mods() & MOD_MASK_RALT ) { - unregister_code( keycode + 0x2E ); - } else { - unregister_code( keycode ); - } - } - return false; } // switch() return true; }; @@ -223,9 +173,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { [_FN] = LAYOUT_60_ansi( KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_DEL, _______, KC_CALC, KC_APP, _______, _______, _______, KC_INS, KC_HOME, KC_UP, KC_END, KC_PGUP, KC_PSCR, KC_SLCK, KC_PAUS, - NO_CHNG, M_SALL, _______, _______, _______, _______, KC_DEL, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN, _______, KC_PENT, + _______, M_SALL, _______, _______, _______, _______, KC_DEL, KC_LEFT, KC_DOWN, KC_RGHT, KC_PGDN, _______, KC_PENT, _______, M_UNDO, M_CUT, M_COPY, M_PASTE, _______, _______, KC_MUTE, KC_VOLD, KC_VOLU, TG(_SY), _______, - _______, _______, _______, TG(_NP), _______, _______, NO_CHNG, _______ + _______, _______, _______, TG(_NP), _______, _______, _______, _______ ), /***************** @@ -238,7 +188,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { _______, _______, _______, _______, KC_E, KC_F, _______, KC_P4, KC_P5, KC_P6, KC_PAST, KC_PSLS, KC_PEQL, _______, _______, _______, _______, _______, KC_C, KC_D, _______, KC_P1, KC_P2, KC_P3, KC_PPLS, KC_PMNS, KC_PENT, _______, _______, _______, _______, KC_A, KC_B, _______, KC_P0, _______, KC_PDOT, _______, _______, - _______, _______, _______, TG(_NP), _______, _______, NO_CHNG, _______ + _______, _______, _______, TG(_NP), _______, _______, _______, _______ ), /* Macro layer */ @@ -247,7 +197,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { _______, _______, _______, G_PUSH, _______, _______, _______, _______, _______, _______, _______, DM_PLY1, DM_PLY2, DM_RSTP, _______, _______, _______, G_FTCH, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, G_BRCH, _______, _______, _______, _______, _______, _______, - _______, _______, _______, _______, _______, _______, NO_CHNG, _______ + _______, _______, _______, _______, _______, _______, _______, _______ ), /* System layer */ @@ -256,7 +206,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { XXXXXXX, XXXXXXX, M_MDSWP, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, BL_DEC, BL_TOGG, BL_INC, BL_BRTG, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, - XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, NO_CHNG, XXXXXXX + XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, XXXXXXX, _______, XXXXXXX ), }; diff --git a/keyboards/kc60/keymaps/noroadsleft/readme.md b/keyboards/kc60/keymaps/noroadsleft/readme.md index 59f4386ee3..8d0c6547a4 100644 --- a/keyboards/kc60/keymaps/noroadsleft/readme.md +++ b/keyboards/kc60/keymaps/noroadsleft/readme.md @@ -1,15 +1,15 @@ # @noroadsleft's KC60 keymap -### Last updated: November 5, 2019, 12:07 AM UTC-0800 +### Last updated: April 26, 2021 13:33 (-0700) - + I am a full-time Dvorak typist, and occasional semi-serious FPS gamer. The layers are oriented towards a mix of typing and gaming. ---- -# Preface +## Preface Images in this readme follow the following format: @@ -21,18 +21,122 @@ Descriptions of the physical locations of keys will use the key's function in a ---- -# Outline +## Outline -- [Base Layers](./readme_ch1.md) +- [Base Layers](#base-layers) - Layer 0: QWERTY `_QW` - Layer 1: Hardware Dvorak `_DV` - Layer 2: Hardware Colemak `_CM` -- [Quake 2 Overlays](./readme_ch2.md) - - Layers 3, 4 and 5: Quake 2 `_Q2`, Quake 2 Dvorak `_QD`, and Quake 2 Console `_QC` -- [Function Layers](./readme_ch3.md) - - Layer 6: Fn layer `_FN` - - Layer 7: Quake 2 Fn layer `_FQ` -- [Other Layers](./readme_ch4.md) - - Layer 8: Numpad layer `_NP` - - Layer 9: Macro layer `_MA` - - Layer 10: System layer `_SY` +- [Quake 2 Layer](#quake-2-layer) + - Layer 3: Quake 2 `_Q2` +- [Function Layer](#function-layer) + - Layer 4: Fn layer `_FN` +- [Other Layers](#other-layers) + - Layer 5: Numpad layer `_NP` + - Layer 6: Macro layer `_MA` + - Layer 7: System layer `_SY` + + +---- + +## Base Layers + +### Layer 0: QWERTY - `_QW` + +Standard QWERTY layout, with four QMK features: + +- The `Menu` key has been replaced by `MO(_FW)`, which moves to my Windows Fn layer when held. +- The Right `GUI` key has been replaced with a `MO(_MA)` key, which moves to the Macro layer when held. +- The `Caps Lock` key has been replaced with a dual function `LT()` key, which opens the Windows Fn layer when held, and is `Caps Lock` when tapped +- The Left `Control` key has been replaced with a `MT(MOD_CTRL, KC_GRV)` key, which is <code>` ~</code> when tapped and `Ctrl` when held. + + + + +---- + +### Layer 1: Hardware Dvorak - `_DV` + +- Accessed by holding either `Fn` and tapping `/?` key, then tapping `2@`. + +A hardware-based Dvorak Simplified layout. At my weekend job, I use a shared computer that runs MacOS Sierra, in US QWERTY layout. In this layer, I can leave the system in QWERTY, plug my keyboard in, and still type in Dvorak. + + + + +---- + +### Layer 2: Hardware Colemak `_CM` + +- Accessed by holding either `Fn` and tapping `/?` key, then tapping `3#`. + +A hardware-based Colemak layout. Been thinking of trying it, so it's here. + + + + +---- + +## Quake 2 Layer + +### Layer 3: Quake 2 `_Q2` + +- Accessed by holding either `Fn` key and tapping the `/?` key, then tapping `4$` + +These layers were born out of the confusion I have had trying to use the in-game chat and the console in [Quake 2](https://en.wikipedia.org/wiki/Quake_II). When Quake 2 came out, alternate keyboard layouts weren't really a thing. As a result, all in-game text input is hard-locked to US QWERTY, regardless of what the operating system is using for its input method. + +I have solved this by writing a custom QMK macro. The keycode in the System layer that enables these layers, [`GO_Q2`](./keymap.c#L205), is a [macro](./keymap.c#L63-L70) that sets the default layer to the QWERTY layer, then turns the Quake 2 layer `_Q2` on. The result is a partially-overwritten QWERTY layer, that changes the dual-function Left Control/Grave key to a standard Left Control, and the Enter key into a special Enter key specific to Quake 2. + +When I hit the `Enter` key (bound in-game to text chat), the [macro keycode](./keymap.c#L71-L86) I've created sends the keycode for `Enter`, then follows with flipping an internal boolean variable and enabling the Hardware Dvorak layer. Now the game is in text chat mode, and my keyboard is in Dvorak. When I hit `Enter` again, another `Enter` key is sent, which sends the message, then the macro flips the boolean back to false and disables the Hardware Dvorak layer, which brings me back to the standard QWERTY+Quake 2 setup. Hitting `Escape` instead runs a [macro](./keymap.c#L87-L97) that cancels the sending of the message, and undoes the layers. + + + + +---- + +## Function Layer + +### Layer 4: Fn layer - `_FN` + +- Accessed by holding either `Fn` key from any base layer + +Arrows, Navigation keys (Insert, Home, Page Up, etc.), and Function keys are here. Also has keys for Calculator, Menu, Volume Control, and shortcuts for Select All, Undo, Cut, Copy, and Paste. Numpad Enter for when I'm working in Adobe Photoshop, because it treats Numpad Enter differently from the regular Enter key. + + + + +---- + +## Other Layers + +### Layer 5: Numpad layer - `_NP` + +- Accessed by holding either `Fn` key and tapping `Space`, from any of the Base Layers + +Puts a Numpad on the right-hand side of the keyboard. A through F included for hexadecimal input. Tapping `Space` returns to the previous Base Layer. + + + + +---- + +### Layer 6: Macro layer - `_MA` + +- Accessed by holding the right-side `Win` key + +Has some macros that I use in Git, and keys for use with the [Dynamic Macros feature](https://docs.qmk.fm/#/feature_dynamic_macros). + +For macro documentation, see [my userspace readme](../../../../users/noroadsleft/readme.md). + + + + +---- + +### Layer 7: System layer - `_SY` + +- Accessed by holding either `Fn` key and tapping the `/?` key + +This is where I change my keyboard function. Base layer select on `1` through `4`, Backlight controls on `C` through `N`, Reset on `8*`, Debug on `0)`. Hitting `Esc` exits the layer. + + diff --git a/keyboards/kc60/keymaps/noroadsleft/readme_ch1.md b/keyboards/kc60/keymaps/noroadsleft/readme_ch1.md deleted file mode 100644 index 87fe99c655..0000000000 --- a/keyboards/kc60/keymaps/noroadsleft/readme_ch1.md +++ /dev/null @@ -1,48 +0,0 @@ -# @noroadsleft's KC60 keymap - -- [Table of Contents](./readme.md) - 1. **Base Layers** - 2. [Quake 2 Overlays](./readme_ch2.md) - 3. [Function Layers](./readme_ch3.md) - 4. [Other Layers](./readme_ch4.md) - - ----- - -## Layer 0: QWERTY - `_QW` - -Standard QWERTY layout, with four QMK features: - -- The `Menu` key has been replaced by `MO(_FW)`, which moves to my Windows Fn layer when held. -- The Right `GUI` key has been replaced with a `MO(_MA)` key, which moves to the Macro layer when held. -- The `Caps Lock` key has been replaced with a dual function `LT()` key, which opens the Windows Fn layer when held, and is `Caps Lock` when tapped -- The Left `Control` key has been replaced with a `MT(MOD_CTRL, KC_GRV)` key, which is <code>` ~</code> when tapped and `Ctrl` when held. - - - - ----- - -## Layer 1: Hardware Dvorak - `_DV` - -### Accessed by holding either `Fn` and tapping `/?` key, then tapping `2@`. - -A hardware-based Dvorak Simplified layout. At my weekend job, I use a shared computer that runs MacOS Sierra, in US QWERTY layout. In this layer, I can leave the system in QWERTY, plug my keyboard in, and still type in Dvorak. - - - - ----- - -## Layer 2: Hardware Colemak `_CM` - -### Accessed by holding either `Fn` and tapping `/?` key, then tapping `3#`. - -A hardware-based Colemak layout. Been thinking of trying it, so it's here. - - - - ----- - -Next Chapter: [Quake 2 Overlays](./readme_ch2.md) diff --git a/keyboards/kc60/keymaps/noroadsleft/readme_ch2.md b/keyboards/kc60/keymaps/noroadsleft/readme_ch2.md deleted file mode 100644 index 427bebb9a1..0000000000 --- a/keyboards/kc60/keymaps/noroadsleft/readme_ch2.md +++ /dev/null @@ -1,36 +0,0 @@ -# @noroadsleft's KC60 keymap - -- [Table of Contents](./readme.md) - 1. [Base Layers](./readme_ch1.md) - 2. **Quake 2 Overlays** - 3. [Function Layers](./readme_ch3.md) - 4. [Other Layers](./readme_ch4.md) - - ----- - -## Layers 3, 4 and 5: Quake 2 `_Q2`, Quake 2 Dvorak `_QD`, and Quake 2 Console `_QC` - -### Accessed by holding either `Fn` key and tapping the `/?` key, then tapping `4$` - -These layers were born out of the confusion I have had trying to use the in-game chat and the console in [Quake 2](https://en.wikipedia.org/wiki/Quake_II). When Quake 2 came out, alternate keyboard layouts weren't really a thing. As a result, all in-game text input is hard-locked to US QWERTY, regardless of what the operating system is using for its input method. - -I'm attempting to solve this by some creative use of QMK's macro feature. The keycode in the System layer that enables these layers, [`GO_Q2`](./keymap.c#L387), is a [macro](./keymap.c#L101-L108) that sets the default layer to the QWERTY layer, then turns the Quake 2 layer `_Q2` on. The result is a partially-overwritten QWERTY layer, that has some keycodes with some creative layer switching. - -When I hit the `Enter` key (bound in-game to text chat), the [macro keycode](./keymap.c#L109-L115) I've created sends the keycode for `Enter`, then follows with enabling the Hardware Dvorak layer and its corresponding overlay. Now the game is in text chat mode, and my keyboard is in Dvorak. When I hit `Enter` again, another `Enter` [keycode macro](./keymap.c#L116-L122) is sent, which sends the message, then the macro brings me back to the standard QWERTY+Quake 2 setup. Hitting `Escape` instead runs a [macro](./keymap.c#L123-L129) that cancels the sending of the message, and undoes the layers. - -I have been testing this configuration for a few months. Sometimes I end up still in Dvorak mode without any text input systems (in-game chat or the console) running, but it pretty much always happens when I'm focused on the game, so I don't know the cause yet. - -### Layer 3: Quake 2 - - -### Layer 4: Quake 2 Dvorak - - -### Layer 5: Quake 2 Console - - - ----- - -Next Chapter: [Function Layers](./readme_ch3.md) diff --git a/keyboards/kc60/keymaps/noroadsleft/readme_ch3.md b/keyboards/kc60/keymaps/noroadsleft/readme_ch3.md deleted file mode 100644 index 57c0bd4900..0000000000 --- a/keyboards/kc60/keymaps/noroadsleft/readme_ch3.md +++ /dev/null @@ -1,40 +0,0 @@ -# @noroadsleft's KC60 keymap - -- [Table of Contents](./readme.md) - 1. [Base Layers](./readme_ch1.md) - 2. [Quake 2 Overlays](./readme_ch2.md) - 3. **Function Layers** - 4. [Other Layers](./readme_ch4.md) - - ----- - -## Layer 6: Fn layer - `_FN` - -### Accessed by holding either `Fn` key from any base layer - -Arrows, Navigation keys (Insert, Home, Page Up, etc.), and Function keys are here. Also has keys for Calculator, Menu, Volume Control, and shortcuts for Select All, Undo, Cut, Copy, and Paste. Numpad Enter for when I'm working in Adobe Photoshop, because it treats Numpad Enter differently from the regular Enter key. - - - - ----- - -## Layer 7: Quake 2 Fn layer - `_FQ` - -### Accessed by holding either `Fn` key while either Quake 2 overlay is active. - -Based on the Windows function layer, but removes some functions that are pointless to have while in the game. - - - -Keycode(s) Sent | Notes -:-------------------------------- | :---- -[`Q2_GRV`](./keymap.c#L130-L137) | Sends `KC_GRV`, then enables the Dvorak, Quake 2 Dvorak, and Quake 2 Console layers. - - - - ----- - -Next Chapter: [Other Layers](./readme_ch4.md) diff --git a/keyboards/kc60/keymaps/noroadsleft/readme_ch4.md b/keyboards/kc60/keymaps/noroadsleft/readme_ch4.md deleted file mode 100644 index 97fa675a9d..0000000000 --- a/keyboards/kc60/keymaps/noroadsleft/readme_ch4.md +++ /dev/null @@ -1,110 +0,0 @@ -# @noroadsleft's KC60 keymap - -- [Table of Contents](./readme.md) - 1. [Base Layers](./readme_ch1.md) - 2. [Quake 2 Overlays](./readme_ch2.md) - 3. [Function Layers](./readme_ch3.md) - 4. **Other Layers** - - ----- - -## Layer 8: Numpad layer - `_NP` - -### Accessed by holding either `Fn` key and tapping `Space`, from any of the Base Layers - -Puts a Numpad on the right-hand side of the keyboard. A through F included for hexadecimal input. Tapping `Space` returns to the previous Base Layer. - - - - ----- - -## Layer 9: Macro layer - `_MA` - -### Accessed by holding the right-side `Win` key - -Has some macros that I use in Git, some frequently-typed strings, and keys for use with the [Dynamic Macros feature](https://docs.qmk.fm/#/feature_dynamic_macros). - -Tapping `Esc` exits the Macro layer, if the macro used doesn't do it automatically. - - - - -### Macros - -#### [G_PUSH](./keymap.c#L71-L75) - -Output: `git push origin ` - -Everything from here down is related to Git or GitHub. - -#### [G_FTCH](./keymap.c#L76-L85) - -| Condition | Output | -| :-------- | :----- | -| If <kbd>Shift</kbd> is active | `git pull upstream ` | -| Otherwise | `git fetch upstream ` | - -#### [G_BRCH](./keymap.c#L86-L95) - -| Condition | Output | -| :-------- | :----- | -| If <kbd>Shift</kbd> is active | `master` | -| Otherwise | `$(git branch-name)` | - -`$(git branch-name)` is a [git alias](./readme_git.md) that returns the name of the current branch. - -#### [SIGNA](./keymap.c#L96-L100) - -Output: `\- @noroadsleft` <kbd>Enter</kbd> - -Sometimes on GitHub, I sign my comments. Types my GitHub name in Markdown syntax, and then taps the `Enter` key. - -#### "Macro Mode" Macros and Customized Keycodes - -Some of my macros and keycodes do different things depending on the value of the [`macroMode` variable](./keymap.c#L65), which is toggled between `0` and `1` by the [`M_MDSWP` custom keycode](./keymap.c#L238-L242). This is mainly at attempt to make various shortcuts the same key combinations between Windows/Linux and MacOS (which I use at home and work, respectively). - -| Keycode | `macroMode == 0` | `macroMode == 1` | `macroMode == 1` with Shift | -| :------------------------------ | :--------------- | :--------------- | :--------------------------- | -| [M_SALL](./keymap.c#L138-L146) | `Ctrl+A` | `Cmd+A` | `Cmd+A` | -| [M_UNDO](./keymap.c#L147-L159) | `Ctrl+Z` | `Cmd+Z` | `Cmd+Shift+Z` | -| [M_CUT](./keymap.c#L160-L168) | `Ctrl+X` | `Cmd+X` | `Cmd+X` | -| [M_COPY](./keymap.c#L169-L177) | `Ctrl+C` | `Cmd+C` | `Cmd+C` | -| [M_PASTE](./keymap.c#L178-L190) | `Ctrl+V` | `Cmd+V` | `Cmd+Shift+Opt+V` | -| `KC_HOME` | `KC_HOME` | `Cmd+Left` | `Cmd+Left` | -| `KC_END` | `KC_END` | `Cmd+Right` | `Cmd+Right` | -| `KC_PSCR` | `KC_PSCR` | `Cmd+Shift+3` | `Cmd+Shift+3` | - -#### [Emulated Non-US Backslash](./keymap.c#L218-L232) - -Sometimes I type in languages from countries that use ISO layout, but my keyboard is ANSI, so I have one key fewer. This macro simulates the Non-US Backslash key if I use Right Alt + Z. - -#### [VRSN](./keymap.c#L233-L237) - -Outputs a string that tells me the Git commit from which my flashed firmware was built. Looks something like: - - kc60/noroadsleft @ 0.6.326-6-gae6d7b-dirty - -#### [Emulated Numeric Keypad](./keymap.c#L243-L257) - -If I hold the Right Alt key, the number row (`KC_1` through `KC_0`) will output numpad keycodes instead of number row keycodes, enabling quicker access to characters like ™ and °. - -#### [Emulated Extended Function Keys](./keymap.c#L258-L272) - -Similar to the emulated numpad, if I hold the Right Alt key with the Fn key, the function row (`KC_F1` through `KC_F12`) will output keycodes `KC_F13` throught `KC_F24`. - ----- - -### Layer 10: System layer - `_SY` - -#### Accessed by holding either `Fn` key and tapping the `/?` key - -This is where I change my keyboard function. Base layer select on `1` through `3`, Backlight controls on `C` through `N`, Reset on `8*`, Debug on `0)`. - - - - ----- - -[Back to the index.](./) diff --git a/keyboards/kc60/keymaps/noroadsleft/readme_git.md b/keyboards/kc60/keymaps/noroadsleft/readme_git.md deleted file mode 100644 index a8564703fc..0000000000 --- a/keyboards/kc60/keymaps/noroadsleft/readme_git.md +++ /dev/null @@ -1,79 +0,0 @@ -# @noroadsleft's Git aliases - -[Return to the directory index.](./) - -``` -[alias] - # Change branches - co = checkout - cob = checkout -b - - # Cherry Pick - cp = cherry-pick - - # Check out a Pull Request locally - # e.g. `git cop 351` fetches the commits from Pull Request #351 and saves it to local branch 'pr/351'. - cop = "!f() { git fetch upstream pull/$1/head:pr/$1; git checkout pr/$1; }; f" - - # Sync master branch - sync = !git checkout master && git fetch upstream 2> /dev/null && git pull -n upstream master && git push origin master - - # Return the abbreviated SHA-1 of the last three commits, oldest to newest - rl = rev-list -n 3 --abbrev-commit --reverse HEAD - - # Add remote repo (for sending PRs to other forks, or checking out someone else's developments) - ar = "!f() { git remote add $1 https://github.com/$2/qmk_firmware.git; }; f" - - # Return the last five commits on the branch, in a more compact format - hist = log --pretty=format:\"%C(yellow)%h%Creset %Cgreen%ad%Creset %Cblue[%an%Cgreen% GK%Cblue]%C(yellow)%d%Creset%n %w(100,0,2)%s%n\" --graph --date=iso-local -n 5 - histt = log --pretty=format:\"* %C(yellow)%h%Creset %<(58,trunc)%s %Cblue%>(18,trunc)%an%Cgreen% G?%Creset @ %Cgreen%ad%Creset\" --date=iso-local -n 5 - histb = log --reverse --pretty=format:\"- %Cblue%>(20,trunc)%an %Creset%<(97,trunc)%s\" --date=iso-local -n 5 - - # Follow a file's filename history - follow = log --follow --name-only --pretty=format:\"%C(yellow)commit %H%Creset%d\nAuthor: %an <%ae>\nDate: %ad%n%n %s%n\" --date=iso-local - - # compact diff - df = "diff --compact-summary" - - # List all the files changed in a commit - dt = "diff-tree --no-commit-id --name-only -r" - - # Short-form status - st = "!git status --short --untracked-files=no" - stu = "!git ls-files --others -x '*/*'" - - # Returns the name of the current branch - branch-name = "!git rev-parse --abbrev-ref HEAD" - bn = "!git branch-name" # short-form of the above - # List branches by the date of their last commit, newest to oldest - bbd = "for-each-ref --count=30 --sort=-committerdate refs/heads/ --format='\e[33m%(objectname)\e[0m %(objecttype) \e[32m%(refname:short)\e[0m (%(authordate))'" - - # Compare commit counts between current branch and QMK master - # e.g. `git cc dev_branch upstream/master` returns how many commits are on `dev_branch` and not on `upstream/master`, and vice versa. - cc = "!f() { git fetch upstream; echo \"\e[0;32m$(git branch-name)\e[0m vs. \e[0;31m$2\e[0m\"; git rev-list --left-right --count $1...$2; }; f" - - # Push to origin repo - po = "push origin $(git branch-name)" - - # List the stashes - sl = "stash list" - - # Unstage a file - unstage = "reset HEAD" - - # Restore a file to the state it was in when checked out - restore = "checkout --" - - # Compare local master repo to its upstream branch. If anything is returned, local branch has diverged from upstream. - cm = "!f() { git fetch upstream master; git diff $(git branch-name) upstream/master --compact-summary; }; f" - cml = "!f() { git fetch upstream master; git diff $(git branch-name) upstream/master; }; f" - - # Delete a branch from local and remote - del-branch = "!f() { git branch -d $1; git push origin :$1; git fetch -p origin; }; f" - - # Rebase with signatures - rbv = rebase --exec 'git commit --amend --no-edit -n -S' -i - - # Force push without overwriting established history - pushf = push --force-with-lease -``` |