keyboards/hotdox/keymaps/ninjonas/README.md

   1 # ninjonas Keymap for [ErgoDox (HotDox)](https://www.alpacakeyboards.com/)
   2
   3 ## Setup
   4 - Ensure you've cloned the [qmk](https://github.com/qmk/qmk_firmware) repo
   5 - Create directory `ninjonas` on `/keyboards/hotdox/keymaps/`
   6 - Run `copy_keymap.sh`. This copies the contents of this repo into `%qmk_firmware%/ninjonas/` directory
   7 - To push your keymap to your keyboard run this command `make clean hotdox:ninjonas:dfu`
   8     - this compiles your keymap and creates a `hotdox_ninjonas.hex` file and will atempt to flash your board
   9     - if you get the following message:
  10       ```
  11       dfu-programmer: no device present.
  12       Error: Bootloader not found. Trying again in 5s.
  13       ```
  14     - Press the reset button underneath your ErgoDox keyboard
  15     - The following messages should show up and your board has successfuly been flashed
  16       ```
  17       Bootloader Version: 0x00 (0)
  18       Erasing flash...  Success
  19       Checking memory from 0x0 to 0x6FFF...  Empty.
  20       Checking memory from 0x0 to 0x5D7F...  Empty.
  21       0%                            100%  Programming 0x5D80 bytes...
  22       [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>]  Success
  23       0%                            100%  Reading 0x7000 bytes...
  24       [>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>]  Success
  25       Validating...  Success
  26       0x5D80 bytes written into 0x7000 bytes memory (83.48%).
  27       ```
  28     - The alterenative is follow the steps on [Hotdox flashing guide](https://www.alpacakeyboards.com/flash/hot-dox-ergodox-76-flashing-instructions)
  29
  30 ## Keymap
  31 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](https://github.com/ninjonas/qmk-yonas/tree/master/users/ninjonas).
  32
  33 ### QWERTY
  34 ```c
  35 /* Keymap 0: QWERTY
  36  *
  37  * ,--------------------------------------------------.           ,--------------------------------------------------.
  38  * |   `    |   1  |   2  |   3  |   4  |   5  | Play |           |K_LOCK |   6  |   7  |   8  |   9  |   0  |   -    |
  39  * |--------+------+------+------+------+-------------|           |-------+------+------+------+------+------+--------|
  40  * | Tab    |   Q  |   W  |   E  |   R  |   T  |      |           |       |   Y  |   U  |   I  |   O  |   P  |   \    |
  41  * |--------+------+------+------+------+------|      |           |       |------+------+------+------+------+--------|
  42  * | Esc    |   A  |   S  |   D  |   F  |   G  |------|           |-------|   H  |   J  |   K  |   L  |  ;   |   '    |
  43  * |--------+------+------+------+------+------|  [   |           |   ]   |------+------+------+------+------+--------|
  44  * | LShift |   Z  |   X  |   C  |   V  |   B  |      |           |       |   N  |   M  |   ,  |   .  |  /   |   =    |
  45  * `--------+------+------+------+------+-------------'           `--------------+------+------+------+------+--------'
  46  *   |M_SHFT|      | Alt  |     | Ctl  |                                        | BkSP | Del  |LOWER |M_ZOOM|M_PYNV|
  47  *   `----------------------------------'                                        `----------------------------------'
  48  *                                        ,-------------.       ,-------------.
  49  *                                        |  Up  | Down |       | Left | Right|
  50  *                                 ,------|------|------|       |------+------+------.
  51  *                                 |      |      | Home |       | PgUp |      |      |
  52  *                                 | Space|Backsp|------|       |------| Del  |Enter |
  53  *                                 |      |ace   | End  |       | PgDn |      |      |
  54  *                                 `--------------------'       `--------------------'
  55  */
  56 ```
  57
  58 ### LOWER
  59 ```c
  60 /* Keymap 1: LOWER
  61  *
  62  * ,--------------------------------------------------.           ,----------------------------------------------------.
  63  * |  F11   |  F1  |  F2  |  F3  |  F4  |  F5  |      |           |       |  F6  |  F7  |  F8  |  F9  |  F10  |  F12   |
  64  * |--------+------+------+------+------+-------------|           |-------+------+------+------+------+-------+--------|
  65  * |        |      |      |KC_BRU| Play | Mute |      |           |       | PgUp | Home |  Up  | End  |       |        |
  66  * |--------+------+------+------+------+------|      |           |       |------+------+------+------+-------+--------|
  67  * |        |      |      |KC_BRD| Next |VolUp |------|           |-------| PgDn | Left | Down |Right |K_LOCK |        |
  68  * |--------+------+------+------+------+------|      |           |       |------+------+------+------+-------+--------|
  69  * |        |      |      |      | Prev |VolDn |      |           |       |      |      |      |      |       |        |
  70  * `--------+------+------+------+------+-------------'           `--------------+------+------+------+-------+--------'
  71  *   |      |      |      |      |      |                                        |      |      |      |M_CODE |      |
  72  *   `----------------------------------'                                        `-----------------------------------'
  73  *                                        ,-------------.       ,-------------.
  74  *                                        |      |      |       |      |      |
  75  *                                 ,------|------|------|       |------+------+------.
  76  *                                 |      |      |      |       |      |      |      |
  77  *                                 |      |      |------|       |------|      |      |
  78  *                                 |      |      |      |       |      |      |      |
  79  *                                 `--------------------'       `--------------------'
  80  */
  81 ```
  82
  83 ### RAISE
  84 ```c
  85 /* Keymap 2: RAISE
  86  *
  87  * ,--------------------------------------------------.           ,----------------------------------------------------.
  88  * |        |      |      |      |K_CSCN|      |      |           |       |      |      |      |      |       |        |
  89  * |--------+------+------+------+------+-------------|           |-------+------+------+------+------+-------+--------|
  90  * | M_MAKE |      | MS_1 | MS_U | MS_2 | WH_U |      |           |       |      |      |      |      |       |        |
  91  * |--------+------+------+------+------+------|      |           |       |------+------+------+------+-------+--------|
  92  * | M_VRSN |      | MS_L | MS_D | MS_R | WH_D |------|           |-------|      |      |      |      |       |        |
  93  * |--------+------+------+------+------+------|      |           |       |------+------+------+------+-------+--------|
  94  * | M_FLSH |      |      |      |      |      |      |           |       |      |      |      |      |       |        |
  95  * `--------+------+------+------+------+-------------'           `--------------+------+------+------+-------+--------'
  96  *   |      |      |      |      |      |                                        |      |      |      |       |      |
  97  *   `----------------------------------'                                        `-----------------------------------'
  98  *                                        ,-------------.       ,-------------.
  99  *                                        |      |      |       |      |      |
 100  *                                 ,------|------|------|       |------+------+------.
 101  *                                 |      |      |      |       |      |      |      |
 102  *                                 |      |      |------|       |------|      |      |
 103  *                                 |      |      |      |       |      |      |      |
 104  *                                 `--------------------'       `--------------------'
 105  */
 106 ```