diff --git a/README.md b/README.md index 1a531242..8077d71b 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,46 @@ This repository is a valid QMK external userspace as documented [here](https://docs.qmk.fm/newbs_external_userspace). To use it, you need: -1. QMK setup locally. See [QMK Docs](https://docs.qmk.fm/newbs_getting_started) for details -2. Clone this repository and add it as an overlay: - - ``` - qmk config user.overlay_dir="/home/chzerv/qmk_keymap/" - ``` - -3. To build the firmware: +1. QMK setup locally. See [QMK Docs](https://docs.qmk.fm/newbs_getting_started) for details. ```shell + qmk setup + ``` +2. Clone this repository locally. + ``` + git clone https://github.com/chzerv/qmk_keymap + ``` +3. Add the cloned repository as an overlay (replace `path/to/qmk_keymap` with the path of the cloned repo). + + ```shell + + qmk config user.overlay_dir="$(realpath path/to/qmk_keymap)" + ``` + +4. (optional) set a default keyboard and keymap. + + ```shell + qmk config user.keyboard=keebio/iris_ce/rev1 + qmk config user.keymap=chzerv + ``` + +5. Build and flash. + + ```shell + qmk compile -kb keebio/iris_ce/rev1 -km chzerv qmk flash -kb keebio/iris_ce/rev1 -km chzerv + + # Or, if you followed step #4 + qmk compile + qmk flash ``` ## TODO - [ ] My symbol layer needs a bit more tweaking -- [x] Make my `Control/Escape` mod-tap send a one-shot `Ctrl` when held +- ~~Make my `Control/Escape` mod-tap send a one-shot `Ctrl` when held~~ + - Turns out this causes more trouble than it solves: + - `Ctrl + Mouse` doesn't work + - `Ctrl` only applies to the first key, which makes shortcuts like deleting backwards in the shell using `Ctrl+h` feel very awkward, as you have to keep pressing `Ctrl` # Credits diff --git a/keyboards/keebio/iris_ce/keymaps/chzerv/keymap.c b/keyboards/keebio/iris_ce/keymaps/chzerv/keymap.c index cc3cf004..9587e4ef 100644 --- a/keyboards/keebio/iris_ce/keymaps/chzerv/keymap.c +++ b/keyboards/keebio/iris_ce/keymaps/chzerv/keymap.c @@ -44,7 +44,7 @@ enum custom_layers { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { [_BASE] = LAYOUT( //┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐ - KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, + KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_DEL, //├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤ KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS, //├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤ @@ -61,7 +61,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { //┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, //├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤ - _______, _______, TAB_EXT, TAB_NXT, TAB_PRV, TAB_NEW, KC_HOME, KC_PGDN, KC_PGUP, KC_END, XXXXXXX, KC_BSPC, + _______, _______, TAB_EXT, TAB_PRV, TAB_NXT, TAB_NEW, KC_HOME, KC_PGDN, KC_PGUP, KC_END, XXXXXXX, KC_BSPC, //├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤ _______, OSM_G, OSM_A, OSM_S, OSM_C, _______, KC_LEFT, KC_DOWN, KC_UP, KC_RIGHT,SELWORD, XXXXXXX, //├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ @@ -75,7 +75,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { //┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐ _______, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_MINS, //├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤ - TMUX_, KC_QUOT, KC_LT, KC_GT, KC_DQUO, KC_GRV, LITERAL, KC_LBRC, KC_RBRC, KC_RBRC, KC_AT, _______, + _______, KC_QUOT, KC_LT, KC_GT, KC_DQUO, KC_GRV, LITERAL, KC_LBRC, KC_RBRC, KC_COLN, KC_AT, _______, //├────────┼────────┼────────┼────────┼────────┼────────┤ ├────────┼────────┼────────┼────────┼────────┼────────┤ _______, KC_HASH, KC_EQL, KC_UNDS, KC_DLR, KC_ASTR, KC_SLSH, KC_LPRN, KC_RPRN, KC_SCLN, KC_QUES, _______, //├────────┼────────┼────────┼────────┼────────┼────────┼────────┐ ┌────────┼────────┼────────┼────────┼────────┼────────┼────────┤ @@ -85,7 +85,6 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { // └────────┴────────┴────────┘ └────────┴────────┴────────┘ ), - [_FUN] = LAYOUT( //┌────────┬────────┬────────┬────────┬────────┬────────┐ ┌────────┬────────┬────────┬────────┬────────┬────────┐ KC_F12, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, @@ -114,8 +113,6 @@ bool process_record_user(uint16_t keycode, keyrecord_t* record) { } } - // Other macros... - // Select word if (!process_select_word(keycode, record, SELWORD)) { return false; }